Index

node_modules_/rxjs/src/operator/catch.ts

_catch
_catch(this: typeReference, selector: undefined)

Catches errors on the observable to be handled by returning a new observable or throwing an error.

Parameters :
Name Type Optional Description
this typeReference
selector

a function that takes as arguments err, which is the error, and caught, which is the source observable, in case you'd like to "retry" that observable by returning it again. Whatever observable is returned by the selector will be used to continue the observable chain.

Example :
Continues with a different Observable when there's an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => Observable.of('I', 'II', 'III', 'IV', 'V')) .subscribe(x => console.log(x)); // 1, 2, 3, I, II, III, IV, V

Retries the caught source Observable again in case of error, similar to retry() operator

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n === 4) { throw 'four!'; } return n; }) .catch((err, caught) => caught) .take(30) .subscribe(x => console.log(x)); // 1, 2, 3, 1, 2, 3, ...

Throws a new error when the source Observable throws an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => { throw 'error in source. Details: ' + err; }) .subscribe( x => console.log(x), err => console.log(err) ); // 1, 2, 3, error in source. Details: four!

node_modules__/rxjs/src/operator/catch.ts

_catch
_catch(this: typeReference, selector: undefined)

Catches errors on the observable to be handled by returning a new observable or throwing an error.

Parameters :
Name Type Optional Description
this typeReference
selector

a function that takes as arguments err, which is the error, and caught, which is the source observable, in case you'd like to "retry" that observable by returning it again. Whatever observable is returned by the selector will be used to continue the observable chain.

Example :
Continues with a different Observable when there's an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => Observable.of('I', 'II', 'III', 'IV', 'V')) .subscribe(x => console.log(x)); // 1, 2, 3, I, II, III, IV, V

Retries the caught source Observable again in case of error, similar to retry() operator

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n === 4) { throw 'four!'; } return n; }) .catch((err, caught) => caught) .take(30) .subscribe(x => console.log(x)); // 1, 2, 3, 1, 2, 3, ...

Throws a new error when the source Observable throws an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => { throw 'error in source. Details: ' + err; }) .subscribe( x => console.log(x), err => console.log(err) ); // 1, 2, 3, error in source. Details: four!

node_modules_/rxjs/src/operator/do.ts

_do
_do(this: typeReference, next: undefined, error?: undefined, complete?: undefined)
Parameters :
Name Type Optional Description
this typeReference
next
error true
complete true
_do
_do(this: typeReference, observer: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observer typeReference
_do
_do(this: typeReference, nextOrObserver?: undefined, error?: undefined, complete?: undefined)

Perform a side effect for every emission on the source Observable, but return an Observable that is identical to the source.

Intercepts each emission on the source and runs a function, but returns an output which is identical to the source as long as errors don't occur.

Returns a mirrored Observable of the source Observable, but modified so that the provided Observer is called to perform a side effect for every value, error, and completion emitted by the source. Any errors that are thrown in the aforementioned Observer or handlers are safely sent down the error path of the output Observable.

This operator is useful for debugging your Observables for the correct values or performing other side effects.

Note: this is different to a subscribe on the Observable. If the Observable returned by do is not subscribed, the side effects specified by the Observer will never happen. do therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

Parameters :
Name Type Optional Description
this typeReference
nextOrObserver true

A normal Observer object or a callback for next.

error true

Callback for errors in the source.

complete true

Callback for the completion of the source.

Example :

Map every click to the clientX position of that click, while also logging the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks .do(ev => console.log(ev)) .map(ev => ev.clientX); positions.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/do.ts

_do
_do(this: typeReference, nextOrObserver?: undefined, error?: undefined, complete?: undefined)

Perform a side effect for every emission on the source Observable, but return an Observable that is identical to the source.

Intercepts each emission on the source and runs a function, but returns an output which is identical to the source as long as errors don't occur.

Returns a mirrored Observable of the source Observable, but modified so that the provided Observer is called to perform a side effect for every value, error, and completion emitted by the source. Any errors that are thrown in the aforementioned Observer or handlers are safely sent down the error path of the output Observable.

This operator is useful for debugging your Observables for the correct values or performing other side effects.

Note: this is different to a subscribe on the Observable. If the Observable returned by do is not subscribed, the side effects specified by the Observer will never happen. do therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

Parameters :
Name Type Optional Description
this typeReference
nextOrObserver true

A normal Observer object or a callback for next.

error true

Callback for errors in the source.

complete true

Callback for the completion of the source.

Example :

Map every click to the clientX position of that click, while also logging the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks .do(ev => console.log(ev)) .map(ev => ev.clientX); positions.subscribe(x => console.log(x));

_do
_do(this: typeReference, observer: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observer typeReference
_do
_do(this: typeReference, next: undefined, error?: undefined, complete?: undefined)
Parameters :
Name Type Optional Description
this typeReference
next
error true
complete true

node_modules_/rxjs/src/operator/finally.ts

_finally
_finally(this: typeReference, callback: undefined)

Returns an Observable that mirrors the source Observable, but will call a specified function when the source terminates on complete or error.

Parameters :
Name Type Optional Description
this typeReference
callback

Function to be called when source terminates.

node_modules__/rxjs/src/operator/finally.ts

_finally
_finally(this: typeReference, callback: undefined)

Returns an Observable that mirrors the source Observable, but will call a specified function when the source terminates on complete or error.

Parameters :
Name Type Optional Description
this typeReference
callback

Function to be called when source terminates.

node_modules__/zone.js/lib/browser/define-property.ts

_redefineProperty
_redefineProperty(obj: any, prop: string, desc: any)
Parameters :
Name Type Optional Description
obj any
prop string
desc any
_tryDefineProperty
_tryDefineProperty(obj: any, prop: string, desc: any, originalConfigurableFlag: any)
Parameters :
Name Type Optional Description
obj any
prop string
desc any
originalConfigurableFlag any
isUnconfigurable
isUnconfigurable(obj: any, prop: any)
Parameters :
Name Type Optional Description
obj any
prop any
propertyPatch
propertyPatch()
rewriteDescriptor
rewriteDescriptor(obj: any, prop: string, desc: any)
Parameters :
Name Type Optional Description
obj any
prop string
desc any

node_modules_/zone.js/lib/browser/define-property.ts

_redefineProperty
_redefineProperty(obj: any, prop: string, desc: any)
Parameters :
Name Type Optional Description
obj any
prop string
desc any
_tryDefineProperty
_tryDefineProperty(obj: any, prop: string, desc: any, originalConfigurableFlag: any)
Parameters :
Name Type Optional Description
obj any
prop string
desc any
originalConfigurableFlag any
isUnconfigurable
isUnconfigurable(obj: any, prop: any)
Parameters :
Name Type Optional Description
obj any
prop any
propertyPatch
propertyPatch()
rewriteDescriptor
rewriteDescriptor(obj: any, prop: string, desc: any)
Parameters :
Name Type Optional Description
obj any
prop string
desc any

node_modules__/rxjs/src/operator/switch.ts

_switch
_switch(this: typeReference)

Converts a higher-order Observable into a first-order Observable by subscribing to only the most recently emitted of those inner Observables.

Flattens an Observable-of-Observables by dropping the previous inner Observable once a new one appears.

switch subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable subscribes to the inner Observable and begins emitting the items emitted by that. So far, it behaves like {@link mergeAll}. However, when a new inner Observable is emitted, switch unsubscribes from the earlier-emitted inner Observable and subscribes to the new inner Observable and begins emitting items from it. It continues to behave like this for subsequent inner Observables.

Parameters :
Name Type Optional Description
this typeReference
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); // Each click event is mapped to an Observable that ticks every second var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var switched = higherOrder.switch(); // The outcome is that switched is essentially a timer that restarts // on every click. The interval Observables from older clicks do not merge // with the current interval Observable. switched.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/switch.ts

_switch
_switch(this: typeReference)

Converts a higher-order Observable into a first-order Observable by subscribing to only the most recently emitted of those inner Observables.

Flattens an Observable-of-Observables by dropping the previous inner Observable once a new one appears.

switch subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable subscribes to the inner Observable and begins emitting the items emitted by that. So far, it behaves like {@link mergeAll}. However, when a new inner Observable is emitted, switch unsubscribes from the earlier-emitted inner Observable and subscribes to the new inner Observable and begins emitting items from it. It continues to behave like this for subsequent inner Observables.

Parameters :
Name Type Optional Description
this typeReference
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); // Each click event is mapped to an Observable that ticks every second var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var switched = higherOrder.switch(); // The outcome is that switched is essentially a timer that restarts // on every click. The interval Observables from older clicks do not merge // with the current interval Observable. switched.subscribe(x => console.log(x));

node_modules_/zone.js/lib/zone-spec/long-stack-trace.ts

addErrorStack
addErrorStack(lines: undefined, error: typeReference)
Parameters :
Name Type Optional Description
lines
error typeReference
captureStackTraces
captureStackTraces(stackTraces: undefined, count: number)
Parameters :
Name Type Optional Description
stackTraces
count number
computeIgnoreFrames
computeIgnoreFrames()
getFrames
getFrames(error: typeReference)
Parameters :
Name Type Optional Description
error typeReference
getStacktraceWithCaughtError
getStacktraceWithCaughtError()
getStacktraceWithUncaughtError
getStacktraceWithUncaughtError()
renderLongStackTrace
renderLongStackTrace(frames: undefined, stack: string)
Parameters :
Name Type Optional Description
frames
stack string

node_modules__/zone.js/lib/zone-spec/long-stack-trace.ts

addErrorStack
addErrorStack(lines: undefined, error: typeReference)
Parameters :
Name Type Optional Description
lines
error typeReference
captureStackTraces
captureStackTraces(stackTraces: undefined, count: number)
Parameters :
Name Type Optional Description
stackTraces
count number
computeIgnoreFrames
computeIgnoreFrames()
getFrames
getFrames(error: typeReference)
Parameters :
Name Type Optional Description
error typeReference
getStacktraceWithCaughtError
getStacktraceWithCaughtError()
getStacktraceWithUncaughtError
getStacktraceWithUncaughtError()
renderLongStackTrace
renderLongStackTrace(frames: undefined, stack: string)
Parameters :
Name Type Optional Description
frames
stack string

node_modules__/rxjs/src/observable/dom/AjaxObservable.ts

ajaxDelete
ajaxDelete(url: string, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
headers typeReference true
ajaxGet
ajaxGet(url: string, headers: typeReference)
Parameters :
Name Type Optional Description
url string
headers typeReference
ajaxGetJSON
ajaxGetJSON(url: string, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
headers typeReference true
ajaxPatch
ajaxPatch(url: string, body?: any, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
body any true
headers typeReference true
ajaxPost
ajaxPost(url: string, body?: any, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
body any true
headers typeReference true
ajaxPut
ajaxPut(url: string, body?: any, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
body any true
headers typeReference true
getCORSRequest
getCORSRequest(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference
getXMLHttpRequest
getXMLHttpRequest()
parseXhrResponse
parseXhrResponse(responseType: string, xhr: typeReference)
Parameters :
Name Type Optional Description
responseType string
xhr typeReference

node_modules_/rxjs/src/observable/dom/AjaxObservable.ts

ajaxDelete
ajaxDelete(url: string, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
headers typeReference true
ajaxGet
ajaxGet(url: string, headers: typeReference)
Parameters :
Name Type Optional Description
url string
headers typeReference
ajaxGetJSON
ajaxGetJSON(url: string, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
headers typeReference true
ajaxPatch
ajaxPatch(url: string, body?: any, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
body any true
headers typeReference true
ajaxPost
ajaxPost(url: string, body?: any, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
body any true
headers typeReference true
ajaxPut
ajaxPut(url: string, body?: any, headers?: typeReference)
Parameters :
Name Type Optional Description
url string
body any true
headers typeReference true
getCORSRequest
getCORSRequest(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference
getXMLHttpRequest
getXMLHttpRequest()
parseXhrResponse
parseXhrResponse(responseType: string, xhr: typeReference)
Parameters :
Name Type Optional Description
responseType string
xhr typeReference

node_modules_/zone.js/lib/browser/websocket.ts

apply
apply(api: typeReference, _global: any)
Parameters :
Name Type Optional Description
api typeReference
_global any

node_modules__/zone.js/lib/browser/websocket.ts

apply
apply(api: typeReference, _global: any)
Parameters :
Name Type Optional Description
api typeReference
_global any

node_modules_/rxjs/src/util/applyMixins.ts

applyMixins
applyMixins(derivedCtor: any, baseCtors: undefined)
Parameters :
Name Type Optional Description
derivedCtor any
baseCtors

node_modules__/rxjs/src/util/applyMixins.ts

applyMixins
applyMixins(derivedCtor: any, baseCtors: undefined)
Parameters :
Name Type Optional Description
derivedCtor any
baseCtors

node_modules_/rxjs/src/util/assign.ts

assignImpl
assignImpl(target: typeReference, ...sources: undefined)
Parameters :
Name Type Optional Description
target typeReference
sources
getAssign
getAssign(root: any)
Parameters :
Name Type Optional Description
root any

node_modules__/rxjs/src/util/assign.ts

assignImpl
assignImpl(target: typeReference, ...sources: undefined)
Parameters :
Name Type Optional Description
target typeReference
sources
getAssign
getAssign(root: any)
Parameters :
Name Type Optional Description
root any

node_modules_/zone.js/lib/common/utils.ts

attachOriginToPatched
attachOriginToPatched(patched: typeReference, original: any)
Parameters :
Name Type Optional Description
patched typeReference
original any
bindArguments
bindArguments(args: undefined, source: string)
Parameters :
Name Type Optional Description
args
source string
isIEOrEdge
isIEOrEdge()
isPropertyWritable
isPropertyWritable(propertyDesc: any)
Parameters :
Name Type Optional Description
propertyDesc any
patchClass
patchClass(className: string)
Parameters :
Name Type Optional Description
className string
patchMacroTask
patchMacroTask(obj: any, funcName: string, metaCreator: undefined)
Parameters :
Name Type Optional Description
obj any
funcName string
metaCreator
patchMethod
patchMethod(target: any, name: string, patchFn: undefined)
Parameters :
Name Type Optional Description
target any
name string
patchFn
patchMicroTask
patchMicroTask(obj: any, funcName: string, metaCreator: undefined)
Parameters :
Name Type Optional Description
obj any
funcName string
metaCreator
patchOnProperties
patchOnProperties(obj: any, properties: undefined, prototype?: any)
Parameters :
Name Type Optional Description
obj any
properties
prototype any true
patchProperty
patchProperty(obj: any, prop: string, prototype?: any)
Parameters :
Name Type Optional Description
obj any
prop string
prototype any true
patchPrototype
patchPrototype(prototype: any, fnNames: undefined)
Parameters :
Name Type Optional Description
prototype any
fnNames
scheduleMacroTaskWithCurrentZone
scheduleMacroTaskWithCurrentZone(source: string, callback: typeReference, data: typeReference, customSchedule: undefined, customCancel: undefined)
Parameters :
Name Type Optional Description
source string
callback typeReference
data typeReference
customSchedule
customCancel
wrapWithCurrentZone
wrapWithCurrentZone(callback: typeReference, source: string)
Parameters :
Name Type Optional Description
callback typeReference
source string

node_modules__/zone.js/lib/common/utils.ts

attachOriginToPatched
attachOriginToPatched(patched: typeReference, original: any)
Parameters :
Name Type Optional Description
patched typeReference
original any
bindArguments
bindArguments(args: undefined, source: string)
Parameters :
Name Type Optional Description
args
source string
isIEOrEdge
isIEOrEdge()
isPropertyWritable
isPropertyWritable(propertyDesc: any)
Parameters :
Name Type Optional Description
propertyDesc any
patchClass
patchClass(className: string)
Parameters :
Name Type Optional Description
className string
patchMacroTask
patchMacroTask(obj: any, funcName: string, metaCreator: undefined)
Parameters :
Name Type Optional Description
obj any
funcName string
metaCreator
patchMethod
patchMethod(target: any, name: string, patchFn: undefined)
Parameters :
Name Type Optional Description
target any
name string
patchFn
patchMicroTask
patchMicroTask(obj: any, funcName: string, metaCreator: undefined)
Parameters :
Name Type Optional Description
obj any
funcName string
metaCreator
patchOnProperties
patchOnProperties(obj: any, properties: undefined, prototype?: any)
Parameters :
Name Type Optional Description
obj any
properties
prototype any true
patchProperty
patchProperty(obj: any, prop: string, prototype?: any)
Parameters :
Name Type Optional Description
obj any
prop string
prototype any true
patchPrototype
patchPrototype(prototype: any, fnNames: undefined)
Parameters :
Name Type Optional Description
prototype any
fnNames
scheduleMacroTaskWithCurrentZone
scheduleMacroTaskWithCurrentZone(source: string, callback: typeReference, data: typeReference, customSchedule: undefined, customCancel: undefined)
Parameters :
Name Type Optional Description
source string
callback typeReference
data typeReference
customSchedule
customCancel
wrapWithCurrentZone
wrapWithCurrentZone(callback: typeReference, source: string)
Parameters :
Name Type Optional Description
callback typeReference
source string

node_modules__/rxjs/src/operator/audit.ts

audit
audit(this: typeReference, durationSelector: undefined)

Ignores source values for a duration determined by another Observable, then emits the most recent value from the source Observable, then repeats this process.

It's like {@link auditTime}, but the silencing duration is determined by a second Observable.

audit is similar to throttle, but emits the last value from the silenced time window, instead of the first value. audit emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
this typeReference
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration, returned as an Observable or a Promise.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.audit(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/audit.ts

audit
audit(durationSelector: undefined)

Ignores source values for a duration determined by another Observable, then emits the most recent value from the source Observable, then repeats this process.

It's like {@link auditTime}, but the silencing duration is determined by a second Observable.

audit is similar to throttle, but emits the last value from the silenced time window, instead of the first value. audit emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration, returned as an Observable or a Promise.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.audit(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/audit.ts

audit
audit(durationSelector: undefined)

Ignores source values for a duration determined by another Observable, then emits the most recent value from the source Observable, then repeats this process.

It's like {@link auditTime}, but the silencing duration is determined by a second Observable.

audit is similar to throttle, but emits the last value from the silenced time window, instead of the first value. audit emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration, returned as an Observable or a Promise.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.audit(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/audit.ts

audit
audit(this: typeReference, durationSelector: undefined)

Ignores source values for a duration determined by another Observable, then emits the most recent value from the source Observable, then repeats this process.

It's like {@link auditTime}, but the silencing duration is determined by a second Observable.

audit is similar to throttle, but emits the last value from the silenced time window, instead of the first value. audit emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
this typeReference
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration, returned as an Observable or a Promise.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.audit(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/auditTime.ts

auditTime
auditTime(this: typeReference, duration: number, scheduler: typeReference)

Ignores source values for duration milliseconds, then emits the most recent value from the source Observable, then repeats this process.

When it sees a source values, it ignores that plus the next ones for duration milliseconds, and then it emits the most recent value from the source.

auditTime is similar to throttleTime, but emits the last value from the silenced time window, instead of the first value. auditTime emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
this typeReference
duration number

Time to wait before emitting the most recent source value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.auditTime(1000); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/auditTime.ts

auditTime
auditTime(duration: number, scheduler: typeReference)

Ignores source values for duration milliseconds, then emits the most recent value from the source Observable, then repeats this process.

When it sees a source values, it ignores that plus the next ones for duration milliseconds, and then it emits the most recent value from the source.

auditTime is similar to throttleTime, but emits the last value from the silenced time window, instead of the first value. auditTime emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
duration number

Time to wait before emitting the most recent source value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.auditTime(1000); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/auditTime.ts

auditTime
auditTime(this: typeReference, duration: number, scheduler: typeReference)

Ignores source values for duration milliseconds, then emits the most recent value from the source Observable, then repeats this process.

When it sees a source values, it ignores that plus the next ones for duration milliseconds, and then it emits the most recent value from the source.

auditTime is similar to throttleTime, but emits the last value from the silenced time window, instead of the first value. auditTime emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
this typeReference
duration number

Time to wait before emitting the most recent source value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.auditTime(1000); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/auditTime.ts

auditTime
auditTime(duration: number, scheduler: typeReference)

Ignores source values for duration milliseconds, then emits the most recent value from the source Observable, then repeats this process.

When it sees a source values, it ignores that plus the next ones for duration milliseconds, and then it emits the most recent value from the source.

auditTime is similar to throttleTime, but emits the last value from the silenced time window, instead of the first value. auditTime emits the most recent value from the source Observable on the output Observable as soon as its internal timer becomes disabled, and ignores source values while the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, then the most recent source value is emitted on the output Observable, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
duration number

Time to wait before emitting the most recent source value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.auditTime(1000); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/buffer.ts

buffer
buffer(closingNotifier: typeReference)

Buffers the source Observable values until closingNotifier emits.

Collects values from the past as an array, and emits that array only when another Observable emits.

Buffers the incoming Observable values until the given closingNotifier Observable emits a value, at which point it emits the buffer on the output Observable and starts a new buffer internally, awaiting the next time closingNotifier emits.

Parameters :
Name Type Optional Description
closingNotifier typeReference

An Observable that signals the buffer to be emitted on the output Observable.

Example :

On every click, emit array of most recent interval events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var buffered = interval.buffer(clicks); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/buffer.ts

buffer
buffer(this: typeReference, closingNotifier: typeReference)

Buffers the source Observable values until closingNotifier emits.

Collects values from the past as an array, and emits that array only when another Observable emits.

Buffers the incoming Observable values until the given closingNotifier Observable emits a value, at which point it emits the buffer on the output Observable and starts a new buffer internally, awaiting the next time closingNotifier emits.

Parameters :
Name Type Optional Description
this typeReference
closingNotifier typeReference

An Observable that signals the buffer to be emitted on the output Observable.

Example :

On every click, emit array of most recent interval events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var buffered = interval.buffer(clicks); buffered.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/buffer.ts

buffer
buffer(this: typeReference, closingNotifier: typeReference)

Buffers the source Observable values until closingNotifier emits.

Collects values from the past as an array, and emits that array only when another Observable emits.

Buffers the incoming Observable values until the given closingNotifier Observable emits a value, at which point it emits the buffer on the output Observable and starts a new buffer internally, awaiting the next time closingNotifier emits.

Parameters :
Name Type Optional Description
this typeReference
closingNotifier typeReference

An Observable that signals the buffer to be emitted on the output Observable.

Example :

On every click, emit array of most recent interval events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var buffered = interval.buffer(clicks); buffered.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/buffer.ts

buffer
buffer(closingNotifier: typeReference)

Buffers the source Observable values until closingNotifier emits.

Collects values from the past as an array, and emits that array only when another Observable emits.

Buffers the incoming Observable values until the given closingNotifier Observable emits a value, at which point it emits the buffer on the output Observable and starts a new buffer internally, awaiting the next time closingNotifier emits.

Parameters :
Name Type Optional Description
closingNotifier typeReference

An Observable that signals the buffer to be emitted on the output Observable.

Example :

On every click, emit array of most recent interval events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var buffered = interval.buffer(clicks); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/bufferCount.ts

bufferCount
bufferCount(bufferSize: number, startBufferEvery: number)

Buffers the source Observable values until the size hits the maximum bufferSize given.

Collects values from the past as an array, and emits that array only when its size reaches bufferSize.

Buffers a number of values from the source Observable by bufferSize then emits the buffer and clears it, and starts a new buffer each startBufferEvery values. If startBufferEvery is not provided or is null, then new buffers are started immediately at the start of the source and when each buffer closes and is emitted.

Parameters :
Name Type Optional Description
bufferSize number

The maximum size of the buffer emitted.

startBufferEvery number

Interval at which to start a new buffer. For example if startBufferEvery is 2, then a new buffer will be started on every other value from the source. A new buffer is started at the beginning of the source by default.

Example :

Emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2); buffered.subscribe(x => console.log(x));

On every click, emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2, 1); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/bufferCount.ts

bufferCount
bufferCount(this: typeReference, bufferSize: number, startBufferEvery: number)

Buffers the source Observable values until the size hits the maximum bufferSize given.

Collects values from the past as an array, and emits that array only when its size reaches bufferSize.

Buffers a number of values from the source Observable by bufferSize then emits the buffer and clears it, and starts a new buffer each startBufferEvery values. If startBufferEvery is not provided or is null, then new buffers are started immediately at the start of the source and when each buffer closes and is emitted.

Parameters :
Name Type Optional Description
this typeReference
bufferSize number

The maximum size of the buffer emitted.

startBufferEvery number

Interval at which to start a new buffer. For example if startBufferEvery is 2, then a new buffer will be started on every other value from the source. A new buffer is started at the beginning of the source by default.

Example :

Emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2); buffered.subscribe(x => console.log(x));

On every click, emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2, 1); buffered.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/bufferCount.ts

bufferCount
bufferCount(this: typeReference, bufferSize: number, startBufferEvery: number)

Buffers the source Observable values until the size hits the maximum bufferSize given.

Collects values from the past as an array, and emits that array only when its size reaches bufferSize.

Buffers a number of values from the source Observable by bufferSize then emits the buffer and clears it, and starts a new buffer each startBufferEvery values. If startBufferEvery is not provided or is null, then new buffers are started immediately at the start of the source and when each buffer closes and is emitted.

Parameters :
Name Type Optional Description
this typeReference
bufferSize number

The maximum size of the buffer emitted.

startBufferEvery number

Interval at which to start a new buffer. For example if startBufferEvery is 2, then a new buffer will be started on every other value from the source. A new buffer is started at the beginning of the source by default.

Example :

Emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2); buffered.subscribe(x => console.log(x));

On every click, emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2, 1); buffered.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/bufferCount.ts

bufferCount
bufferCount(bufferSize: number, startBufferEvery: number)

Buffers the source Observable values until the size hits the maximum bufferSize given.

Collects values from the past as an array, and emits that array only when its size reaches bufferSize.

Buffers a number of values from the source Observable by bufferSize then emits the buffer and clears it, and starts a new buffer each startBufferEvery values. If startBufferEvery is not provided or is null, then new buffers are started immediately at the start of the source and when each buffer closes and is emitted.

Parameters :
Name Type Optional Description
bufferSize number

The maximum size of the buffer emitted.

startBufferEvery number

Interval at which to start a new buffer. For example if startBufferEvery is 2, then a new buffer will be started on every other value from the source. A new buffer is started at the beginning of the source by default.

Example :

Emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2); buffered.subscribe(x => console.log(x));

On every click, emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2, 1); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/bufferTime.ts

bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number, bufferCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number
bufferCreationInterval number
scheduler typeReference true
bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number)

Buffers the source Observable values for a specific time period.

Collects values from the past as an array, and emits those arrays periodically in time.

Buffers values from the source for a specific time duration bufferTimeSpan. Unless the optional argument bufferCreationInterval is given, it emits and resets the buffer every bufferTimeSpan milliseconds. If bufferCreationInterval is given, this operator opens the buffer every bufferCreationInterval milliseconds and closes (emits and resets) the buffer every bufferTimeSpan milliseconds. When the optional argument maxBufferSize is specified, the buffer will be closed either after bufferTimeSpan milliseconds or when it contains maxBufferSize elements.

Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number

The amount of time to fill each buffer array.

Example :

Every second, emit an array of the recent click events var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(1000); buffered.subscribe(x => console.log(x));

Every 5 seconds, emit the click events from the next 2 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(2000, 5000); buffered.subscribe(x => console.log(x));

bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number
scheduler typeReference true
bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number, bufferCreationInterval: number, maxBufferSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number
bufferCreationInterval number
maxBufferSize number
scheduler typeReference true

node_modules_/rxjs/src/operators/bufferTime.ts

bufferTime
bufferTime(bufferTimeSpan: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferTimeSpan number
scheduler typeReference true
bufferTime
bufferTime(bufferTimeSpan: number, bufferCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferTimeSpan number
bufferCreationInterval number
scheduler typeReference true
bufferTime
bufferTime(bufferTimeSpan: number, bufferCreationInterval: number, maxBufferSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferTimeSpan number
bufferCreationInterval number
maxBufferSize number
scheduler typeReference true
bufferTime
bufferTime(bufferTimeSpan: number)

Buffers the source Observable values for a specific time period.

Collects values from the past as an array, and emits those arrays periodically in time.

Buffers values from the source for a specific time duration bufferTimeSpan. Unless the optional argument bufferCreationInterval is given, it emits and resets the buffer every bufferTimeSpan milliseconds. If bufferCreationInterval is given, this operator opens the buffer every bufferCreationInterval milliseconds and closes (emits and resets) the buffer every bufferTimeSpan milliseconds. When the optional argument maxBufferSize is specified, the buffer will be closed either after bufferTimeSpan milliseconds or when it contains maxBufferSize elements.

Parameters :
Name Type Optional Description
bufferTimeSpan number

The amount of time to fill each buffer array.

Example :

Every second, emit an array of the recent click events var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(1000); buffered.subscribe(x => console.log(x));

Every 5 seconds, emit the click events from the next 2 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(2000, 5000); buffered.subscribe(x => console.log(x));

dispatchBufferClose
dispatchBufferClose(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchBufferCreation
dispatchBufferCreation(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
dispatchBufferTimeSpanOnly
dispatchBufferTimeSpanOnly(this: typeReference, state: any)
Parameters :
Name Type Optional Description
this typeReference
state any

node_modules__/rxjs/src/operators/bufferTime.ts

bufferTime
bufferTime(bufferTimeSpan: number, bufferCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferTimeSpan number
bufferCreationInterval number
scheduler typeReference true
bufferTime
bufferTime(bufferTimeSpan: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferTimeSpan number
scheduler typeReference true
bufferTime
bufferTime(bufferTimeSpan: number)

Buffers the source Observable values for a specific time period.

Collects values from the past as an array, and emits those arrays periodically in time.

Buffers values from the source for a specific time duration bufferTimeSpan. Unless the optional argument bufferCreationInterval is given, it emits and resets the buffer every bufferTimeSpan milliseconds. If bufferCreationInterval is given, this operator opens the buffer every bufferCreationInterval milliseconds and closes (emits and resets) the buffer every bufferTimeSpan milliseconds. When the optional argument maxBufferSize is specified, the buffer will be closed either after bufferTimeSpan milliseconds or when it contains maxBufferSize elements.

Parameters :
Name Type Optional Description
bufferTimeSpan number

The amount of time to fill each buffer array.

Example :

Every second, emit an array of the recent click events var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(1000); buffered.subscribe(x => console.log(x));

Every 5 seconds, emit the click events from the next 2 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(2000, 5000); buffered.subscribe(x => console.log(x));

bufferTime
bufferTime(bufferTimeSpan: number, bufferCreationInterval: number, maxBufferSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferTimeSpan number
bufferCreationInterval number
maxBufferSize number
scheduler typeReference true
dispatchBufferClose
dispatchBufferClose(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchBufferCreation
dispatchBufferCreation(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
dispatchBufferTimeSpanOnly
dispatchBufferTimeSpanOnly(this: typeReference, state: any)
Parameters :
Name Type Optional Description
this typeReference
state any

node_modules_/rxjs/src/operator/bufferTime.ts

bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number, bufferCreationInterval: number, maxBufferSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number
bufferCreationInterval number
maxBufferSize number
scheduler typeReference true
bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number, bufferCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number
bufferCreationInterval number
scheduler typeReference true
bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number)

Buffers the source Observable values for a specific time period.

Collects values from the past as an array, and emits those arrays periodically in time.

Buffers values from the source for a specific time duration bufferTimeSpan. Unless the optional argument bufferCreationInterval is given, it emits and resets the buffer every bufferTimeSpan milliseconds. If bufferCreationInterval is given, this operator opens the buffer every bufferCreationInterval milliseconds and closes (emits and resets) the buffer every bufferTimeSpan milliseconds. When the optional argument maxBufferSize is specified, the buffer will be closed either after bufferTimeSpan milliseconds or when it contains maxBufferSize elements.

Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number

The amount of time to fill each buffer array.

Example :

Every second, emit an array of the recent click events var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(1000); buffered.subscribe(x => console.log(x));

Every 5 seconds, emit the click events from the next 2 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(2000, 5000); buffered.subscribe(x => console.log(x));

bufferTime
bufferTime(this: typeReference, bufferTimeSpan: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferTimeSpan number
scheduler typeReference true

node_modules_/rxjs/src/operator/bufferToggle.ts

bufferToggle
bufferToggle(this: typeReference, openings: typeReference, closingSelector: undefined)

Buffers the source Observable values starting from an emission from openings and ending when the output of closingSelector emits.

Collects values from the past as an array. Starts collecting only when opening emits, and calls the closingSelector function to get an Observable that tells when to close the buffer.

Buffers values from the source by opening the buffer via signals from an Observable provided to openings, and closing and sending the buffers when a Subscribable or Promise returned by the closingSelector function emits.

Parameters :
Name Type Optional Description
this typeReference
openings typeReference

A Subscribable or Promise of notifications to start new buffers.

closingSelector

A function that takes the value emitted by the openings observable and returns a Subscribable or Promise, which, when it emits, signals that the associated buffer should be emitted and cleared.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var buffered = clicks.bufferToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ); buffered.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/bufferToggle.ts

bufferToggle
bufferToggle(openings: typeReference, closingSelector: undefined)

Buffers the source Observable values starting from an emission from openings and ending when the output of closingSelector emits.

Collects values from the past as an array. Starts collecting only when opening emits, and calls the closingSelector function to get an Observable that tells when to close the buffer.

Buffers values from the source by opening the buffer via signals from an Observable provided to openings, and closing and sending the buffers when a Subscribable or Promise returned by the closingSelector function emits.

Parameters :
Name Type Optional Description
openings typeReference

A Subscribable or Promise of notifications to start new buffers.

closingSelector

A function that takes the value emitted by the openings observable and returns a Subscribable or Promise, which, when it emits, signals that the associated buffer should be emitted and cleared.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var buffered = clicks.bufferToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/bufferToggle.ts

bufferToggle
bufferToggle(openings: typeReference, closingSelector: undefined)

Buffers the source Observable values starting from an emission from openings and ending when the output of closingSelector emits.

Collects values from the past as an array. Starts collecting only when opening emits, and calls the closingSelector function to get an Observable that tells when to close the buffer.

Buffers values from the source by opening the buffer via signals from an Observable provided to openings, and closing and sending the buffers when a Subscribable or Promise returned by the closingSelector function emits.

Parameters :
Name Type Optional Description
openings typeReference

A Subscribable or Promise of notifications to start new buffers.

closingSelector

A function that takes the value emitted by the openings observable and returns a Subscribable or Promise, which, when it emits, signals that the associated buffer should be emitted and cleared.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var buffered = clicks.bufferToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/bufferToggle.ts

bufferToggle
bufferToggle(this: typeReference, openings: typeReference, closingSelector: undefined)

Buffers the source Observable values starting from an emission from openings and ending when the output of closingSelector emits.

Collects values from the past as an array. Starts collecting only when opening emits, and calls the closingSelector function to get an Observable that tells when to close the buffer.

Buffers values from the source by opening the buffer via signals from an Observable provided to openings, and closing and sending the buffers when a Subscribable or Promise returned by the closingSelector function emits.

Parameters :
Name Type Optional Description
this typeReference
openings typeReference

A Subscribable or Promise of notifications to start new buffers.

closingSelector

A function that takes the value emitted by the openings observable and returns a Subscribable or Promise, which, when it emits, signals that the associated buffer should be emitted and cleared.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var buffered = clicks.bufferToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/bufferWhen.ts

bufferWhen
bufferWhen(closingSelector: undefined)

Buffers the source Observable values, using a factory function of closing Observables to determine when to close, emit, and reset the buffer.

Collects values from the past as an array. When it starts collecting values, it calls a function that returns an Observable that tells when to close the buffer and restart collecting.

Opens a buffer immediately, then closes the buffer when the observable returned by calling closingSelector function emits a value. When it closes the buffer, it immediately opens a new buffer and repeats the process.

Parameters :
Name Type Optional Description
closingSelector

A function that takes no arguments and returns an Observable that signals buffer closure.

Example :

Emit an array of the last clicks every [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000) ); buffered.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/bufferWhen.ts

bufferWhen
bufferWhen(this: typeReference, closingSelector: undefined)

Buffers the source Observable values, using a factory function of closing Observables to determine when to close, emit, and reset the buffer.

Collects values from the past as an array. When it starts collecting values, it calls a function that returns an Observable that tells when to close the buffer and restart collecting.

Opens a buffer immediately, then closes the buffer when the observable returned by calling closingSelector function emits a value. When it closes the buffer, it immediately opens a new buffer and repeats the process.

Parameters :
Name Type Optional Description
this typeReference
closingSelector

A function that takes no arguments and returns an Observable that signals buffer closure.

Example :

Emit an array of the last clicks every [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000) ); buffered.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/bufferWhen.ts

bufferWhen
bufferWhen(this: typeReference, closingSelector: undefined)

Buffers the source Observable values, using a factory function of closing Observables to determine when to close, emit, and reset the buffer.

Collects values from the past as an array. When it starts collecting values, it calls a function that returns an Observable that tells when to close the buffer and restart collecting.

Opens a buffer immediately, then closes the buffer when the observable returned by calling closingSelector function emits a value. When it closes the buffer, it immediately opens a new buffer and repeats the process.

Parameters :
Name Type Optional Description
this typeReference
closingSelector

A function that takes no arguments and returns an Observable that signals buffer closure.

Example :

Emit an array of the last clicks every [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000) ); buffered.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/bufferWhen.ts

bufferWhen
bufferWhen(closingSelector: undefined)

Buffers the source Observable values, using a factory function of closing Observables to determine when to close, emit, and reset the buffer.

Collects values from the past as an array. When it starts collecting values, it calls a function that returns an Observable that tells when to close the buffer and restart collecting.

Opens a buffer immediately, then closes the buffer when the observable returned by calling closingSelector function emits a value. When it closes the buffer, it immediately opens a new buffer and repeats the process.

Parameters :
Name Type Optional Description
closingSelector

A function that takes no arguments and returns an Observable that signals buffer closure.

Example :

Emit an array of the last clicks every [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000) ); buffered.subscribe(x => console.log(x));

node_modules_/zone.js/lib/browser/property-descriptor.ts

canPatchViaPropertyDescriptor
canPatchViaPropertyDescriptor()
filterProperties
filterProperties(target: any, onProperties: undefined, ignoreProperties: undefined)
Parameters :
Name Type Optional Description
target any
onProperties
ignoreProperties
patchFilteredProperties
patchFilteredProperties(target: any, onProperties: undefined, ignoreProperties: undefined, prototype?: any)
Parameters :
Name Type Optional Description
target any
onProperties
ignoreProperties
prototype any true
patchViaCapturingAllTheEvents
patchViaCapturingAllTheEvents()
propertyDescriptorPatch
propertyDescriptorPatch(api: typeReference, _global: any)
Parameters :
Name Type Optional Description
api typeReference
_global any

node_modules__/zone.js/lib/browser/property-descriptor.ts

canPatchViaPropertyDescriptor
canPatchViaPropertyDescriptor()
filterProperties
filterProperties(target: any, onProperties: undefined, ignoreProperties: undefined)
Parameters :
Name Type Optional Description
target any
onProperties
ignoreProperties
patchFilteredProperties
patchFilteredProperties(target: any, onProperties: undefined, ignoreProperties: undefined, prototype?: any)
Parameters :
Name Type Optional Description
target any
onProperties
ignoreProperties
prototype any true
patchViaCapturingAllTheEvents
patchViaCapturingAllTheEvents()
propertyDescriptorPatch
propertyDescriptorPatch(api: typeReference, _global: any)
Parameters :
Name Type Optional Description
api typeReference
_global any

node_modules_/rxjs/src/operators/catchError.ts

catchError
catchError(selector: undefined)

Catches errors on the observable to be handled by returning a new observable or throwing an error.

Parameters :
Name Type Optional Description
selector

a function that takes as arguments err, which is the error, and caught, which is the source observable, in case you'd like to "retry" that observable by returning it again. Whatever observable is returned by the selector will be used to continue the observable chain.

Example :
Continues with a different Observable when there's an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => Observable.of('I', 'II', 'III', 'IV', 'V')) .subscribe(x => console.log(x)); // 1, 2, 3, I, II, III, IV, V

Retries the caught source Observable again in case of error, similar to retry() operator

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n === 4) { throw 'four!'; } return n; }) .catch((err, caught) => caught) .take(30) .subscribe(x => console.log(x)); // 1, 2, 3, 1, 2, 3, ...

Throws a new error when the source Observable throws an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => { throw 'error in source. Details: ' + err; }) .subscribe( x => console.log(x), err => console.log(err) ); // 1, 2, 3, error in source. Details: four!

node_modules__/rxjs/src/operators/catchError.ts

catchError
catchError(selector: undefined)

Catches errors on the observable to be handled by returning a new observable or throwing an error.

Parameters :
Name Type Optional Description
selector

a function that takes as arguments err, which is the error, and caught, which is the source observable, in case you'd like to "retry" that observable by returning it again. Whatever observable is returned by the selector will be used to continue the observable chain.

Example :
Continues with a different Observable when there's an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => Observable.of('I', 'II', 'III', 'IV', 'V')) .subscribe(x => console.log(x)); // 1, 2, 3, I, II, III, IV, V

Retries the caught source Observable again in case of error, similar to retry() operator

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n === 4) { throw 'four!'; } return n; }) .catch((err, caught) => caught) .take(30) .subscribe(x => console.log(x)); // 1, 2, 3, 1, 2, 3, ...

Throws a new error when the source Observable throws an error

Observable.of(1, 2, 3, 4, 5) .map(n => { if (n == 4) { throw 'four!'; } return n; }) .catch(err => { throw 'error in source. Details: ' + err; }) .subscribe( x => console.log(x), err => console.log(err) ); // 1, 2, 3, error in source. Details: four!

node_modules_/@compodoc/compodoc/src/utils/utils.ts

cleanLifecycleHooksFromMethods
cleanLifecycleHooksFromMethods(methods: typeReference)
Parameters :
Name Type Optional Description
methods typeReference
cleanSourcesForWatch
cleanSourcesForWatch(list: )
Parameters :
Name Type Optional Description
list
getCanonicalFileName
getCanonicalFileName(fileName: string)
Parameters :
Name Type Optional Description
fileName string
getNamesCompareFn
getNamesCompareFn(name?: )
Parameters :
Name Type Optional Description
name true
getNewLine
getNewLine()
handlePath
handlePath(files: typeReference, cwd: string)
Parameters :
Name Type Optional Description
files typeReference
cwd string
hasBom
hasBom(source: string)
Parameters :
Name Type Optional Description
source string
markedtags
markedtags(tags: typeReference)
Parameters :
Name Type Optional Description
tags typeReference
mergeTagsAndArgs
mergeTagsAndArgs(args: typeReference, jsdoctags?: typeReference)
Parameters :
Name Type Optional Description
args typeReference
jsdoctags typeReference true
readConfig
readConfig(configFile: string)
Parameters :
Name Type Optional Description
configFile string
stripBom
stripBom(source: string)
Parameters :
Name Type Optional Description
source string

node_modules__/@compodoc/compodoc/src/utils/utils.ts

cleanLifecycleHooksFromMethods
cleanLifecycleHooksFromMethods(methods: typeReference)
Parameters :
Name Type Optional Description
methods typeReference
cleanSourcesForWatch
cleanSourcesForWatch(list: )
Parameters :
Name Type Optional Description
list
getCanonicalFileName
getCanonicalFileName(fileName: string)
Parameters :
Name Type Optional Description
fileName string
getNamesCompareFn
getNamesCompareFn(name?: )
Parameters :
Name Type Optional Description
name true
getNewLine
getNewLine()
handlePath
handlePath(files: typeReference, cwd: string)
Parameters :
Name Type Optional Description
files typeReference
cwd string
hasBom
hasBom(source: string)
Parameters :
Name Type Optional Description
source string
markedtags
markedtags(tags: typeReference)
Parameters :
Name Type Optional Description
tags typeReference
mergeTagsAndArgs
mergeTagsAndArgs(args: typeReference, jsdoctags?: typeReference)
Parameters :
Name Type Optional Description
args typeReference
jsdoctags typeReference true
readConfig
readConfig(configFile: string)
Parameters :
Name Type Optional Description
configFile string
stripBom
stripBom(source: string)
Parameters :
Name Type Optional Description
source string

node_modules__/@compodoc/compodoc/src/utilities.ts

cleanNameWithoutSpaceAndToLowerCase
cleanNameWithoutSpaceAndToLowerCase(name: string)
Parameters :
Name Type Optional Description
name string
compilerHost
compilerHost(transpileOptions: any)
Parameters :
Name Type Optional Description
transpileOptions any
detectIndent
detectIndent(str: , count: , indent?: )
Parameters :
Name Type Optional Description
str
count
indent true
findMainSourceFolder
findMainSourceFolder(files: undefined)
Parameters :
Name Type Optional Description
files

node_modules_/@compodoc/compodoc/src/utilities.ts

cleanNameWithoutSpaceAndToLowerCase
cleanNameWithoutSpaceAndToLowerCase(name: string)
Parameters :
Name Type Optional Description
name string
compilerHost
compilerHost(transpileOptions: any)
Parameters :
Name Type Optional Description
transpileOptions any
detectIndent
detectIndent(str: , count: , indent?: )
Parameters :
Name Type Optional Description
str
count
indent true
findMainSourceFolder
findMainSourceFolder(files: undefined)
Parameters :
Name Type Optional Description
files

node_modules__/rxjs/src/operator/combineAll.ts

combineAll
combineAll(this: typeReference, project?: undefined)

Converts a higher-order Observable into a first-order Observable by waiting for the outer Observable to complete, then applying {@link combineLatest}.

Flattens an Observable-of-Observables by applying {@link combineLatest} when the Observable-of-Observables completes.

Takes an Observable of Observables, and collects all Observables from it. Once the outer Observable completes, it subscribes to all collected Observables and combines their values using the {@link combineLatest} strategy, such that:

  • Every time an inner Observable emits, the output Observable emits.
  • When the returned observable emits, it emits all of the latest values by:
    • If a project function is provided, it is called with each recent value from each inner Observable in whatever order they arrived, and the result of the project function is what is emitted by the output Observable.
    • If there is no project function, an array of all of the most recent values is emitted by the output Observable.
Parameters :
Name Type Optional Description
this typeReference
project true

An optional function to map the most recent values from each inner Observable into a new result. Takes each of the most recent values from each collected inner Observable as arguments, in order.

Example :

Map two click events to a finite interval Observable, then apply combineAll var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(Math.random()*2000).take(3) ).take(2); var result = higherOrder.combineAll(); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/combineAll.ts

combineAll
combineAll(project?: undefined)
Parameters :
Name Type Optional Description
project true

node_modules__/rxjs/src/operators/combineAll.ts

combineAll
combineAll(project?: undefined)
Parameters :
Name Type Optional Description
project true

node_modules_/rxjs/src/operator/combineAll.ts

combineAll
combineAll(this: typeReference, project?: undefined)

Converts a higher-order Observable into a first-order Observable by waiting for the outer Observable to complete, then applying {@link combineLatest}.

Flattens an Observable-of-Observables by applying {@link combineLatest} when the Observable-of-Observables completes.

Takes an Observable of Observables, and collects all Observables from it. Once the outer Observable completes, it subscribes to all collected Observables and combines their values using the {@link combineLatest} strategy, such that:

  • Every time an inner Observable emits, the output Observable emits.
  • When the returned observable emits, it emits all of the latest values by:
    • If a project function is provided, it is called with each recent value from each inner Observable in whatever order they arrived, and the result of the project function is what is emitted by the output Observable.
    • If there is no project function, an array of all of the most recent values is emitted by the output Observable.
Parameters :
Name Type Optional Description
this typeReference
project true

An optional function to map the most recent values from each inner Observable into a new result. Takes each of the most recent values from each collected inner Observable as arguments, in order.

Example :

Map two click events to a finite interval Observable, then apply combineAll var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(Math.random()*2000).take(3) ).take(2); var result = higherOrder.combineAll(); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/combineLatest.ts

combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
combineLatest
combineLatest(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
combineLatest
combineLatest(this: typeReference, array: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
combineLatest
combineLatest(this: typeReference, array: undefined, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
project
combineLatest
combineLatest(this: typeReference, observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

combineLatest combines the values from this Observable with values from Observables passed as arguments. This is done by subscribing to each Observable, in order, and collecting an array of each of the most recent values any time any of the input Observables emits, then either taking that array and passing it as arguments to an optional project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference
Example :

Dynamically calculate the Body-Mass Index from an Observable of weight and one for height var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = weight.combineLatest(height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

// With output to console: // BMI is 24.212293388429753 // BMI is 23.93948099205209 // BMI is 23.671253629592222

combineLatest
combineLatest(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference

node_modules_/rxjs/src/operators/combineLatest.ts

combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
project
combineLatest
combineLatest(v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
project
combineLatest
combineLatest(v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
project
combineLatest
combineLatest(project: undefined)
Parameters :
Name Type Optional Description
project
combineLatest
combineLatest(observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

combineLatest combines the values from this Observable with values from Observables passed as arguments. This is done by subscribing to each Observable, in order, and collecting an array of each of the most recent values any time any of the input Observables emits, then either taking that array and passing it as arguments to an optional project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Dynamically calculate the Body-Mass Index from an Observable of weight and one for height var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = weight.combineLatest(height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

// With output to console: // BMI is 24.212293388429753 // BMI is 23.93948099205209 // BMI is 23.671253629592222

combineLatest
combineLatest(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
combineLatest
combineLatest(array: undefined)
Parameters :
Name Type Optional Description
array
combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
combineLatest
combineLatest(v2: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project

node_modules__/rxjs/src/operators/combineLatest.ts

combineLatest
combineLatest(observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

combineLatest combines the values from this Observable with values from Observables passed as arguments. This is done by subscribing to each Observable, in order, and collecting an array of each of the most recent values any time any of the input Observables emits, then either taking that array and passing it as arguments to an optional project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Dynamically calculate the Body-Mass Index from an Observable of weight and one for height var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = weight.combineLatest(height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

// With output to console: // BMI is 24.212293388429753 // BMI is 23.93948099205209 // BMI is 23.671253629592222

combineLatest
combineLatest(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
combineLatest
combineLatest(array: undefined)
Parameters :
Name Type Optional Description
array
combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
combineLatest
combineLatest(v2: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
combineLatest
combineLatest(v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
project
combineLatest
combineLatest(v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
project
combineLatest
combineLatest(v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
project
combineLatest
combineLatest(project: undefined)
Parameters :
Name Type Optional Description
project

node_modules__/rxjs/src/operator/combineLatest.ts

combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
combineLatest
combineLatest(this: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
project
combineLatest
combineLatest(this: typeReference, array: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
combineLatest
combineLatest(this: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
project
combineLatest
combineLatest(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
combineLatest
combineLatest(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
combineLatest
combineLatest(this: typeReference, array: undefined, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
project
combineLatest
combineLatest(this: typeReference, observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

combineLatest combines the values from this Observable with values from Observables passed as arguments. This is done by subscribing to each Observable, in order, and collecting an array of each of the most recent values any time any of the input Observables emits, then either taking that array and passing it as arguments to an optional project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference
Example :

Dynamically calculate the Body-Mass Index from an Observable of weight and one for height var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = weight.combineLatest(height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

// With output to console: // BMI is 24.212293388429753 // BMI is 23.93948099205209 // BMI is 23.671253629592222

combineLatest
combineLatest(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference

node_modules_/rxjs/src/observable/combineLatest.ts

combineLatest
combineLatest(v1: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
combineLatest
combineLatest(array: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
scheduler typeReference true
combineLatest
combineLatest(array: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
scheduler typeReference true
combineLatest
combineLatest(array: undefined, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
project
scheduler typeReference true
combineLatest
combineLatest(array: undefined, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
project
scheduler typeReference true
combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

combineLatest combines the values from all the Observables passed as arguments. This is done by subscribing to each Observable in order and, whenever any Observable emits, collecting an array of the most recent values from each Observable. So if you pass n Observables to operator, returned Observable will always emit an array of n values, in order corresponding to order of passed Observables (value from the first Observable on the first place and so on).

Static version of combineLatest accepts either an array of Observables or each Observable can be put directly as an argument. Note that array of Observables is good choice, if you don't know beforehand how many Observables you will combine. Passing empty array will result in Observable that completes immediately.

To ensure output array has always the same length, combineLatest will actually wait for all input Observables to emit at least once, before it starts emitting results. This means if some Observable emits values before other Observables started emitting, all that values but last will be lost. On the other hand, is some Observable does not emit value but completes, resulting Observable will complete at the same moment without emitting anything, since it will be now impossible to include value from completed Observable in resulting array. Also, if some input Observable does not emit any value and never completes, combineLatest will also never emit and never complete, since, again, it will wait for all streams to emit some value.

If at least one Observable was passed to combineLatest and all passed Observables emitted something, resulting Observable will complete when all combined streams complete. So even if some Observable completes, result of combineLatest will still emit values when other Observables do. In case of completed Observable, its value from now on will always be the last emitted value. On the other hand, if any Observable errors, combineLatest will error immediately as well, and all other Observables will be unsubscribed.

combineLatest accepts as optional parameter project function, which takes as arguments all values that would normally be emitted by resulting Observable. project can return any kind of value, which will be then emitted by Observable instead of default array. Note that project does not take as argument that array of values, but values themselves. That means default project can be imagined as function that takes all its arguments and puts them into an array.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Combine two timer Observables const firstTimer = Rx.Observable.timer(0, 1000); // emit 0, 1, 2... after every second, starting from now const secondTimer = Rx.Observable.timer(500, 1000); // emit 0, 1, 2... after every second, starting 0,5s from now const combinedTimers = Rx.Observable.combineLatest(firstTimer, secondTimer); combinedTimers.subscribe(value => console.log(value)); // Logs // [0, 0] after 0.5s // [1, 0] after 1s // [1, 1] after 1.5s // [2, 1] after 2s

Combine an array of Observables const observables = [1, 5, 10].map( n => Rx.Observable.of(n).delay(n * 1000).startWith(0) // emit 0 and then emit n after n seconds ); const combined = Rx.Observable.combineLatest(observables); combined.subscribe(value => console.log(value)); // Logs // [0, 0, 0] immediately // [1, 0, 0] after 1s // [1, 5, 0] after 5s // [1, 5, 10] after 10s

Use project function to dynamically calculate the Body-Mass Index var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = Rx.Observable.combineLatest(weight, height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

// With output to console: // BMI is 24.212293388429753 // BMI is 23.93948099205209 // BMI is 23.671253629592222

node_modules__/rxjs/src/observable/combineLatest.ts

combineLatest
combineLatest(observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

combineLatest combines the values from all the Observables passed as arguments. This is done by subscribing to each Observable in order and, whenever any Observable emits, collecting an array of the most recent values from each Observable. So if you pass n Observables to operator, returned Observable will always emit an array of n values, in order corresponding to order of passed Observables (value from the first Observable on the first place and so on).

Static version of combineLatest accepts either an array of Observables or each Observable can be put directly as an argument. Note that array of Observables is good choice, if you don't know beforehand how many Observables you will combine. Passing empty array will result in Observable that completes immediately.

To ensure output array has always the same length, combineLatest will actually wait for all input Observables to emit at least once, before it starts emitting results. This means if some Observable emits values before other Observables started emitting, all that values but last will be lost. On the other hand, is some Observable does not emit value but completes, resulting Observable will complete at the same moment without emitting anything, since it will be now impossible to include value from completed Observable in resulting array. Also, if some input Observable does not emit any value and never completes, combineLatest will also never emit and never complete, since, again, it will wait for all streams to emit some value.

If at least one Observable was passed to combineLatest and all passed Observables emitted something, resulting Observable will complete when all combined streams complete. So even if some Observable completes, result of combineLatest will still emit values when other Observables do. In case of completed Observable, its value from now on will always be the last emitted value. On the other hand, if any Observable errors, combineLatest will error immediately as well, and all other Observables will be unsubscribed.

combineLatest accepts as optional parameter project function, which takes as arguments all values that would normally be emitted by resulting Observable. project can return any kind of value, which will be then emitted by Observable instead of default array. Note that project does not take as argument that array of values, but values themselves. That means default project can be imagined as function that takes all its arguments and puts them into an array.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Combine two timer Observables const firstTimer = Rx.Observable.timer(0, 1000); // emit 0, 1, 2... after every second, starting from now const secondTimer = Rx.Observable.timer(500, 1000); // emit 0, 1, 2... after every second, starting 0,5s from now const combinedTimers = Rx.Observable.combineLatest(firstTimer, secondTimer); combinedTimers.subscribe(value => console.log(value)); // Logs // [0, 0] after 0.5s // [1, 0] after 1s // [1, 1] after 1.5s // [2, 1] after 2s

Combine an array of Observables const observables = [1, 5, 10].map( n => Rx.Observable.of(n).delay(n * 1000).startWith(0) // emit 0 and then emit n after n seconds ); const combined = Rx.Observable.combineLatest(observables); combined.subscribe(value => console.log(value)); // Logs // [0, 0, 0] immediately // [1, 0, 0] after 1s // [1, 5, 0] after 5s // [1, 5, 10] after 10s

Use project function to dynamically calculate the Body-Mass Index var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = Rx.Observable.combineLatest(weight, height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

// With output to console: // BMI is 24.212293388429753 // BMI is 23.93948099205209 // BMI is 23.671253629592222

combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
combineLatest
combineLatest(array: undefined, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
project
scheduler typeReference true
combineLatest
combineLatest(array: undefined, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
project
scheduler typeReference true
combineLatest
combineLatest(array: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
scheduler typeReference true
combineLatest
combineLatest(array: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
array
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, v3: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, v2: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
project
scheduler typeReference true
combineLatest
combineLatest(v1: typeReference, project: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
project
scheduler typeReference true

node_modules_/@compodoc/ngd-core/src/lang/utilities.ts

compilerHost
compilerHost(transpileOptions: any)
Parameters :
Name Type Optional Description
transpileOptions any
d
d(node: )
Parameters :
Name Type Optional Description
node
getNewLineCharacter
getNewLineCharacter(options: typeReference)
Parameters :
Name Type Optional Description
options typeReference

node_modules__/@compodoc/ngd-core/src/lang/utilities.ts

compilerHost
compilerHost(transpileOptions: any)
Parameters :
Name Type Optional Description
transpileOptions any
d
d(node: )
Parameters :
Name Type Optional Description
node
getNewLineCharacter
getNewLineCharacter(options: typeReference)
Parameters :
Name Type Optional Description
options typeReference

node_modules_/rxjs/src/operator/concat.ts

concat
concat(this: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
concat
concat(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
concat
concat(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
concat
concat(this: typeReference, observables: typeReference)

Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins this Observable with multiple other Observables by subscribing to them one at a time, starting with the source, and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference
Example :

Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = timer.concat(sequence); result.subscribe(x => console.log(x));

// results in: // 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3 -immediate-> 1 ... 10

Concatenate 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = timer1.concat(timer2, timer3); result.subscribe(x => console.log(x));

// results in the following: // (Prints to console sequentially) // -1000ms-> 0 -1000ms-> 1 -1000ms-> ... 9 // -2000ms-> 0 -2000ms-> 1 -2000ms-> ... 5 // -500ms-> 0 -500ms-> 1 -500ms-> ... 9

node_modules_/rxjs/src/operators/concat.ts

concat
concat(v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
scheduler typeReference true
concat
concat(v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
scheduler typeReference true
concat
concat(scheduler?: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference true
concat
concat(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
concat
concat(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
concat
concat(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
concat
concat(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
concat
concat(observables: typeReference)

Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins this Observable with multiple other Observables by subscribing to them one at a time, starting with the source, and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = timer.concat(sequence); result.subscribe(x => console.log(x));

// results in: // 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3 -immediate-> 1 ... 10

Concatenate 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = timer1.concat(timer2, timer3); result.subscribe(x => console.log(x));

// results in the following: // (Prints to console sequentially) // -1000ms-> 0 -1000ms-> 1 -1000ms-> ... 9 // -2000ms-> 0 -2000ms-> 1 -2000ms-> ... 5 // -500ms-> 0 -500ms-> 1 -500ms-> ... 9

concat
concat(v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true

node_modules__/rxjs/src/operators/concat.ts

concat
concat(scheduler?: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference true
concat
concat(observables: typeReference)

Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins this Observable with multiple other Observables by subscribing to them one at a time, starting with the source, and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = timer.concat(sequence); result.subscribe(x => console.log(x));

// results in: // 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3 -immediate-> 1 ... 10

Concatenate 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = timer1.concat(timer2, timer3); result.subscribe(x => console.log(x));

// results in the following: // (Prints to console sequentially) // -1000ms-> 0 -1000ms-> 1 -1000ms-> ... 9 // -2000ms-> 0 -2000ms-> 1 -2000ms-> ... 5 // -500ms-> 0 -500ms-> 1 -500ms-> ... 9

concat
concat(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
concat
concat(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
concat
concat(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
concat
concat(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
concat
concat(v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
concat
concat(v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
scheduler typeReference true
concat
concat(v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
scheduler typeReference true

node_modules__/rxjs/src/operator/concat.ts

concat
concat(this: typeReference, observables: typeReference)

Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins this Observable with multiple other Observables by subscribing to them one at a time, starting with the source, and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference
Example :

Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = timer.concat(sequence); result.subscribe(x => console.log(x));

// results in: // 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3 -immediate-> 1 ... 10

Concatenate 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = timer1.concat(timer2, timer3); result.subscribe(x => console.log(x));

// results in the following: // (Prints to console sequentially) // -1000ms-> 0 -1000ms-> 1 -1000ms-> ... 9 // -2000ms-> 0 -2000ms-> 1 -2000ms-> ... 5 // -500ms-> 0 -500ms-> 1 -500ms-> ... 9

concat
concat(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
concat
concat(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
concat
concat(this: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
concat
concat(this: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true

node_modules_/rxjs/src/observable/concat.ts

concat
concat(v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
concat
concat(...observables: undefined)
Parameters :
Name Type Optional Description
observables
concat
concat(...observables: undefined)
Parameters :
Name Type Optional Description
observables
concat
concat(observables: typeReference)

Creates an output Observable which sequentially emits all values from given Observable and then moves on to the next.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

concat joins multiple Observables together, by subscribing to them one at a time and merging their results into the output Observable. You can pass either an array of Observables, or put them directly as arguments. Passing an empty array will result in Observable that completes immediately.

concat will subscribe to first input Observable and emit all its values, without changing or affecting them in any way. When that Observable completes, it will subscribe to then next Observable passed and, again, emit its values. This will be repeated, until the operator runs out of Observables. When last input Observable completes, concat will complete as well. At any given moment only one Observable passed to operator emits values. If you would like to emit values from passed Observables concurrently, check out {@link merge} instead, especially with optional concurrent parameter. As a matter of fact, concat is an equivalent of merge operator with concurrent parameter set to 1.

Note that if some input Observable never completes, concat will also never complete and Observables following the one that did not complete will never be subscribed. On the other hand, if some Observable simply completes immediately after it is subscribed, it will be invisible for concat, which will just move on to the next Observable.

If any Observable in chain errors, instead of passing control to the next Observable, concat will error immediately as well. Observables that would be subscribed after the one that emitted error, never will.

If you pass to concat the same Observable many times, its stream of values will be "replayed" on every subscription, which means you can repeat given Observable as many times as you like. If passing the same Observable to concat 1000 times becomes tedious, you can always use {@link repeat}.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = Rx.Observable.concat(timer, sequence); result.subscribe(x => console.log(x));

// results in: // 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3 -immediate-> 1 ... 10

Concatenate an array of 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = Rx.Observable.concat([timer1, timer2, timer3]); // note that array is passed result.subscribe(x => console.log(x));

// results in the following: // (Prints to console sequentially) // -1000ms-> 0 -1000ms-> 1 -1000ms-> ... 9 // -2000ms-> 0 -2000ms-> 1 -2000ms-> ... 5 // -500ms-> 0 -500ms-> 1 -500ms-> ... 9

Concatenate the same Observable to repeat it const timer = Rx.Observable.interval(1000).take(2);

Rx.Observable.concat(timer, timer) // concating the same Observable! .subscribe( value => console.log(value), err => {}, () => console.log('...and it is done!') );

// Logs: // 0 after 1s // 1 after 2s // 0 after 3s // 1 after 4s // "...and it is done!" also after 4s

node_modules__/rxjs/src/observable/concat.ts

concat
concat(v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
concat
concat(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
concat
concat(...observables: undefined)
Parameters :
Name Type Optional Description
observables
concat
concat(...observables: undefined)
Parameters :
Name Type Optional Description
observables
concat
concat(observables: typeReference)

Creates an output Observable which sequentially emits all values from given Observable and then moves on to the next.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

concat joins multiple Observables together, by subscribing to them one at a time and merging their results into the output Observable. You can pass either an array of Observables, or put them directly as arguments. Passing an empty array will result in Observable that completes immediately.

concat will subscribe to first input Observable and emit all its values, without changing or affecting them in any way. When that Observable completes, it will subscribe to then next Observable passed and, again, emit its values. This will be repeated, until the operator runs out of Observables. When last input Observable completes, concat will complete as well. At any given moment only one Observable passed to operator emits values. If you would like to emit values from passed Observables concurrently, check out {@link merge} instead, especially with optional concurrent parameter. As a matter of fact, concat is an equivalent of merge operator with concurrent parameter set to 1.

Note that if some input Observable never completes, concat will also never complete and Observables following the one that did not complete will never be subscribed. On the other hand, if some Observable simply completes immediately after it is subscribed, it will be invisible for concat, which will just move on to the next Observable.

If any Observable in chain errors, instead of passing control to the next Observable, concat will error immediately as well. Observables that would be subscribed after the one that emitted error, never will.

If you pass to concat the same Observable many times, its stream of values will be "replayed" on every subscription, which means you can repeat given Observable as many times as you like. If passing the same Observable to concat 1000 times becomes tedious, you can always use {@link repeat}.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = Rx.Observable.concat(timer, sequence); result.subscribe(x => console.log(x));

// results in: // 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3 -immediate-> 1 ... 10

Concatenate an array of 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = Rx.Observable.concat([timer1, timer2, timer3]); // note that array is passed result.subscribe(x => console.log(x));

// results in the following: // (Prints to console sequentially) // -1000ms-> 0 -1000ms-> 1 -1000ms-> ... 9 // -2000ms-> 0 -2000ms-> 1 -2000ms-> ... 5 // -500ms-> 0 -500ms-> 1 -500ms-> ... 9

Concatenate the same Observable to repeat it const timer = Rx.Observable.interval(1000).take(2);

Rx.Observable.concat(timer, timer) // concating the same Observable! .subscribe( value => console.log(value), err => {}, () => console.log('...and it is done!') );

// Logs: // 0 after 1s // 1 after 2s // 0 after 3s // 1 after 4s // "...and it is done!" also after 4s

node_modules__/rxjs/src/operator/concatAll.ts

concatAll
concatAll(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference
concatAll
concatAll(this: typeReference)

Converts a higher-order Observable into a first-order Observable by concatenating the inner Observables in order.

Flattens an Observable-of-Observables by putting one inner Observable after the other.

Joins every Observable emitted by the source (a higher-order Observable), in a serial fashion. It subscribes to each inner Observable only after the previous inner Observable has completed, and merges all of their values into the returned observable.

Warning: If the source Observable emits Observables quickly and endlessly, and the inner Observables it emits generally complete slower than the source emits, you can run into memory issues as the incoming Observables collect in an unbounded buffer.

Note: concatAll is equivalent to mergeAll with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
this typeReference
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(1000).take(4)); var firstOrder = higherOrder.concatAll(); firstOrder.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

concatAll
concatAll(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference

node_modules_/rxjs/src/operators/concatAll.ts

concatAll
concatAll()

Converts a higher-order Observable into a first-order Observable by concatenating the inner Observables in order.

Flattens an Observable-of-Observables by putting one inner Observable after the other.

Joins every Observable emitted by the source (a higher-order Observable), in a serial fashion. It subscribes to each inner Observable only after the previous inner Observable has completed, and merges all of their values into the returned observable.

Warning: If the source Observable emits Observables quickly and endlessly, and the inner Observables it emits generally complete slower than the source emits, you can run into memory issues as the incoming Observables collect in an unbounded buffer.

Note: concatAll is equivalent to mergeAll with concurrency parameter set to 1.

Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(1000).take(4)); var firstOrder = higherOrder.concatAll(); firstOrder.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

node_modules__/rxjs/src/operators/concatAll.ts

concatAll
concatAll()

Converts a higher-order Observable into a first-order Observable by concatenating the inner Observables in order.

Flattens an Observable-of-Observables by putting one inner Observable after the other.

Joins every Observable emitted by the source (a higher-order Observable), in a serial fashion. It subscribes to each inner Observable only after the previous inner Observable has completed, and merges all of their values into the returned observable.

Warning: If the source Observable emits Observables quickly and endlessly, and the inner Observables it emits generally complete slower than the source emits, you can run into memory issues as the incoming Observables collect in an unbounded buffer.

Note: concatAll is equivalent to mergeAll with concurrency parameter set to 1.

Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(1000).take(4)); var firstOrder = higherOrder.concatAll(); firstOrder.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

node_modules_/rxjs/src/operator/concatAll.ts

concatAll
concatAll(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference
concatAll
concatAll(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference
concatAll
concatAll(this: typeReference)

Converts a higher-order Observable into a first-order Observable by concatenating the inner Observables in order.

Flattens an Observable-of-Observables by putting one inner Observable after the other.

Joins every Observable emitted by the source (a higher-order Observable), in a serial fashion. It subscribes to each inner Observable only after the previous inner Observable has completed, and merges all of their values into the returned observable.

Warning: If the source Observable emits Observables quickly and endlessly, and the inner Observables it emits generally complete slower than the source emits, you can run into memory issues as the incoming Observables collect in an unbounded buffer.

Note: concatAll is equivalent to mergeAll with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
this typeReference
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(1000).take(4)); var firstOrder = higherOrder.concatAll(); firstOrder.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

node_modules_/rxjs/src/operators/concatMap.ts

concatMap
concatMap(project: undefined)
Parameters :
Name Type Optional Description
project
concatMap
concatMap(project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
project
resultSelector
concatMap
concatMap(project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, in a serialized fashion waiting for each one to complete before merging the next.

Maps each value to an Observable, then flattens all of these inner Observables using {@link concatAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMap is equivalent to mergeMap with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMap(ev => Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

node_modules__/rxjs/src/operators/concatMap.ts

concatMap
concatMap(project: undefined)
Parameters :
Name Type Optional Description
project
concatMap
concatMap(project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
project
resultSelector
concatMap
concatMap(project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, in a serialized fashion waiting for each one to complete before merging the next.

Maps each value to an Observable, then flattens all of these inner Observables using {@link concatAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMap is equivalent to mergeMap with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMap(ev => Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

node_modules__/rxjs/src/operator/concatMap.ts

concatMap
concatMap(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
concatMap
concatMap(this: typeReference, project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector
concatMap
concatMap(this: typeReference, project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, in a serialized fashion waiting for each one to complete before merging the next.

Maps each value to an Observable, then flattens all of these inner Observables using {@link concatAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMap is equivalent to mergeMap with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMap(ev => Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

node_modules_/rxjs/src/operator/concatMap.ts

concatMap
concatMap(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
concatMap
concatMap(this: typeReference, project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, in a serialized fashion waiting for each one to complete before merging the next.

Maps each value to an Observable, then flattens all of these inner Observables using {@link concatAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMap is equivalent to mergeMap with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMap(ev => Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

concatMap
concatMap(this: typeReference, project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector

node_modules_/rxjs/src/operators/concatMapTo.ts

concatMapTo
concatMapTo(observable: typeReference)
Parameters :
Name Type Optional Description
observable typeReference
concatMapTo
concatMapTo(innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is merged multiple times in a serialized fashion on the output Observable.

It's like {@link concatMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. Each new innerObservable instance emitted on the output Observable is concatenated with the previous innerObservable instance.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMapTo is equivalent to mergeMapTo with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMapTo(Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

concatMapTo
concatMapTo(observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
observable typeReference
resultSelector

node_modules__/rxjs/src/operator/concatMapTo.ts

concatMapTo
concatMapTo(this: typeReference, observable: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
concatMapTo
concatMapTo(this: typeReference, innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is merged multiple times in a serialized fashion on the output Observable.

It's like {@link concatMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. Each new innerObservable instance emitted on the output Observable is concatenated with the previous innerObservable instance.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMapTo is equivalent to mergeMapTo with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
this typeReference
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMapTo(Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

concatMapTo
concatMapTo(this: typeReference, observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
resultSelector

node_modules_/rxjs/src/operator/concatMapTo.ts

concatMapTo
concatMapTo(this: typeReference, innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is merged multiple times in a serialized fashion on the output Observable.

It's like {@link concatMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. Each new innerObservable instance emitted on the output Observable is concatenated with the previous innerObservable instance.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMapTo is equivalent to mergeMapTo with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
this typeReference
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMapTo(Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

concatMapTo
concatMapTo(this: typeReference, observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
resultSelector
concatMapTo
concatMapTo(this: typeReference, observable: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference

node_modules__/rxjs/src/operators/concatMapTo.ts

concatMapTo
concatMapTo(observable: typeReference)
Parameters :
Name Type Optional Description
observable typeReference
concatMapTo
concatMapTo(innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is merged multiple times in a serialized fashion on the output Observable.

It's like {@link concatMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. Each new innerObservable instance emitted on the output Observable is concatenated with the previous innerObservable instance.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMapTo is equivalent to mergeMapTo with concurrency parameter set to 1.

Parameters :
Name Type Optional Description
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMapTo(Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

// Results in the following: // (results are not concurrent) // For every click on the "document" it will emit values 0 to 3 spaced // on a 1000ms interval // one click = 1000ms-> 0 -1000ms-> 1 -1000ms-> 2 -1000ms-> 3

concatMapTo
concatMapTo(observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
observable typeReference
resultSelector

node_modules_/rxjs/src/operators/count.ts

count
count(predicate?: undefined)

Counts the number of emissions on the source and emits that number when the source completes.

Tells how many values were emitted, when the source completes.

count transforms an Observable that emits values into an Observable that emits a single value that represents the number of values emitted by the source Observable. If the source Observable terminates with an error, count will pass this error notification along without emitting a value first. If the source Observable does not terminate at all, count will neither emit a value nor terminate. This operator takes an optional predicate function as argument, in which case the output emission will represent the number of source values that matched true with the predicate.

Parameters :
Name Type Optional Description
predicate true

A boolean function to select what values are to be counted. It is provided with arguments of:

  • value: the value from the source Observable.
  • index: the (zero-based) "index" of the value from the source Observable.
  • source: the source Observable instance itself.
Example :

Counts how many seconds have passed before the first click happened var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var secondsBeforeClick = seconds.takeUntil(clicks); var result = secondsBeforeClick.count(); result.subscribe(x => console.log(x));

Counts how many odd numbers are there between 1 and 7 var numbers = Rx.Observable.range(1, 7); var result = numbers.count(i => i % 2 === 1); result.subscribe(x => console.log(x));

// Results in: // 4

node_modules__/rxjs/src/operator/count.ts

count
count(this: typeReference, predicate?: undefined)

Counts the number of emissions on the source and emits that number when the source completes.

Tells how many values were emitted, when the source completes.

count transforms an Observable that emits values into an Observable that emits a single value that represents the number of values emitted by the source Observable. If the source Observable terminates with an error, count will pass this error notification along without emitting a value first. If the source Observable does not terminate at all, count will neither emit a value nor terminate. This operator takes an optional predicate function as argument, in which case the output emission will represent the number of source values that matched true with the predicate.

Parameters :
Name Type Optional Description
this typeReference
predicate true

A boolean function to select what values are to be counted. It is provided with arguments of:

  • value: the value from the source Observable.
  • index: the (zero-based) "index" of the value from the source Observable.
  • source: the source Observable instance itself.
Example :

Counts how many seconds have passed before the first click happened var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var secondsBeforeClick = seconds.takeUntil(clicks); var result = secondsBeforeClick.count(); result.subscribe(x => console.log(x));

Counts how many odd numbers are there between 1 and 7 var numbers = Rx.Observable.range(1, 7); var result = numbers.count(i => i % 2 === 1); result.subscribe(x => console.log(x));

// Results in: // 4

node_modules_/rxjs/src/operator/count.ts

count
count(this: typeReference, predicate?: undefined)

Counts the number of emissions on the source and emits that number when the source completes.

Tells how many values were emitted, when the source completes.

count transforms an Observable that emits values into an Observable that emits a single value that represents the number of values emitted by the source Observable. If the source Observable terminates with an error, count will pass this error notification along without emitting a value first. If the source Observable does not terminate at all, count will neither emit a value nor terminate. This operator takes an optional predicate function as argument, in which case the output emission will represent the number of source values that matched true with the predicate.

Parameters :
Name Type Optional Description
this typeReference
predicate true

A boolean function to select what values are to be counted. It is provided with arguments of:

  • value: the value from the source Observable.
  • index: the (zero-based) "index" of the value from the source Observable.
  • source: the source Observable instance itself.
Example :

Counts how many seconds have passed before the first click happened var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var secondsBeforeClick = seconds.takeUntil(clicks); var result = secondsBeforeClick.count(); result.subscribe(x => console.log(x));

Counts how many odd numbers are there between 1 and 7 var numbers = Rx.Observable.range(1, 7); var result = numbers.count(i => i % 2 === 1); result.subscribe(x => console.log(x));

// Results in: // 4

node_modules__/rxjs/src/operators/count.ts

count
count(predicate?: undefined)

Counts the number of emissions on the source and emits that number when the source completes.

Tells how many values were emitted, when the source completes.

count transforms an Observable that emits values into an Observable that emits a single value that represents the number of values emitted by the source Observable. If the source Observable terminates with an error, count will pass this error notification along without emitting a value first. If the source Observable does not terminate at all, count will neither emit a value nor terminate. This operator takes an optional predicate function as argument, in which case the output emission will represent the number of source values that matched true with the predicate.

Parameters :
Name Type Optional Description
predicate true

A boolean function to select what values are to be counted. It is provided with arguments of:

  • value: the value from the source Observable.
  • index: the (zero-based) "index" of the value from the source Observable.
  • source: the source Observable instance itself.
Example :

Counts how many seconds have passed before the first click happened var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var secondsBeforeClick = seconds.takeUntil(clicks); var result = secondsBeforeClick.count(); result.subscribe(x => console.log(x));

Counts how many odd numbers are there between 1 and 7 var numbers = Rx.Observable.range(1, 7); var result = numbers.count(i => i % 2 === 1); result.subscribe(x => console.log(x));

// Results in: // 4

node_modules_/rxjs/src/operator/debounce.ts

debounce
debounce(this: typeReference, durationSelector: undefined)

Emits a value from the source Observable only after a particular time span determined by another Observable has passed without another source emission.

It's like {@link debounceTime}, but the time span of emission silence is determined by a second Observable.

debounce delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and spawns a duration Observable by calling the durationSelector function. The value is emitted only when the duration Observable emits a value or completes, and if no other value was emitted on the source Observable since the duration Observable was spawned. If a new value appears before the duration Observable emits, the previous value will be dropped and will not be emitted on the output Observable.

Like {@link debounceTime}, this is a rate-limiting operator, and also a delay-like operator since output emissions do not necessarily occur at the same time as they did on the source Observable.

Parameters :
Name Type Optional Description
this typeReference
durationSelector

A function that receives a value from the source Observable, for computing the timeout duration for each source value, returned as an Observable or a Promise.

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounce(() => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/debounce.ts

debounce
debounce(this: typeReference, durationSelector: undefined)

Emits a value from the source Observable only after a particular time span determined by another Observable has passed without another source emission.

It's like {@link debounceTime}, but the time span of emission silence is determined by a second Observable.

debounce delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and spawns a duration Observable by calling the durationSelector function. The value is emitted only when the duration Observable emits a value or completes, and if no other value was emitted on the source Observable since the duration Observable was spawned. If a new value appears before the duration Observable emits, the previous value will be dropped and will not be emitted on the output Observable.

Like {@link debounceTime}, this is a rate-limiting operator, and also a delay-like operator since output emissions do not necessarily occur at the same time as they did on the source Observable.

Parameters :
Name Type Optional Description
this typeReference
durationSelector

A function that receives a value from the source Observable, for computing the timeout duration for each source value, returned as an Observable or a Promise.

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounce(() => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/debounce.ts

debounce
debounce(durationSelector: undefined)

Emits a value from the source Observable only after a particular time span determined by another Observable has passed without another source emission.

It's like {@link debounceTime}, but the time span of emission silence is determined by a second Observable.

debounce delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and spawns a duration Observable by calling the durationSelector function. The value is emitted only when the duration Observable emits a value or completes, and if no other value was emitted on the source Observable since the duration Observable was spawned. If a new value appears before the duration Observable emits, the previous value will be dropped and will not be emitted on the output Observable.

Like {@link debounceTime}, this is a rate-limiting operator, and also a delay-like operator since output emissions do not necessarily occur at the same time as they did on the source Observable.

Parameters :
Name Type Optional Description
durationSelector

A function that receives a value from the source Observable, for computing the timeout duration for each source value, returned as an Observable or a Promise.

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounce(() => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/debounce.ts

debounce
debounce(durationSelector: undefined)

Emits a value from the source Observable only after a particular time span determined by another Observable has passed without another source emission.

It's like {@link debounceTime}, but the time span of emission silence is determined by a second Observable.

debounce delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and spawns a duration Observable by calling the durationSelector function. The value is emitted only when the duration Observable emits a value or completes, and if no other value was emitted on the source Observable since the duration Observable was spawned. If a new value appears before the duration Observable emits, the previous value will be dropped and will not be emitted on the output Observable.

Like {@link debounceTime}, this is a rate-limiting operator, and also a delay-like operator since output emissions do not necessarily occur at the same time as they did on the source Observable.

Parameters :
Name Type Optional Description
durationSelector

A function that receives a value from the source Observable, for computing the timeout duration for each source value, returned as an Observable or a Promise.

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounce(() => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/debounceTime.ts

debounceTime
debounceTime(dueTime: number, scheduler: typeReference)

Emits a value from the source Observable only after a particular time span has passed without another source emission.

It's like {@link delay}, but passes only the most recent value from each burst of emissions.

debounceTime delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and emits that only when dueTime enough time has passed without any other value appearing on the source Observable. If a new value appears before dueTime silence occurs, the previous value will be dropped and will not be emitted on the output Observable.

This is a rate-limiting operator, because it is impossible for more than one value to be emitted in any time window of duration dueTime, but it is also a delay-like operator since output emissions do not occur at the same time as they did on the source Observable. Optionally takes a {@link IScheduler} for managing timers.

Parameters :
Name Type Optional Description
dueTime number

The timeout duration in milliseconds (or the time unit determined internally by the optional scheduler) for the window of time required to wait for emission silence before emitting the most recent source value.

scheduler typeReference

The {

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounceTime(1000); result.subscribe(x => console.log(x));

dispatchNext
dispatchNext(subscriber: typeReference)
Parameters :
Name Type Optional Description
subscriber typeReference

node_modules__/rxjs/src/operator/debounceTime.ts

debounceTime
debounceTime(this: typeReference, dueTime: number, scheduler: typeReference)

Emits a value from the source Observable only after a particular time span has passed without another source emission.

It's like {@link delay}, but passes only the most recent value from each burst of emissions.

debounceTime delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and emits that only when dueTime enough time has passed without any other value appearing on the source Observable. If a new value appears before dueTime silence occurs, the previous value will be dropped and will not be emitted on the output Observable.

This is a rate-limiting operator, because it is impossible for more than one value to be emitted in any time window of duration dueTime, but it is also a delay-like operator since output emissions do not occur at the same time as they did on the source Observable. Optionally takes a {@link IScheduler} for managing timers.

Parameters :
Name Type Optional Description
this typeReference
dueTime number

The timeout duration in milliseconds (or the time unit determined internally by the optional scheduler) for the window of time required to wait for emission silence before emitting the most recent source value.

scheduler typeReference

The {

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounceTime(1000); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/debounceTime.ts

debounceTime
debounceTime(this: typeReference, dueTime: number, scheduler: typeReference)

Emits a value from the source Observable only after a particular time span has passed without another source emission.

It's like {@link delay}, but passes only the most recent value from each burst of emissions.

debounceTime delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and emits that only when dueTime enough time has passed without any other value appearing on the source Observable. If a new value appears before dueTime silence occurs, the previous value will be dropped and will not be emitted on the output Observable.

This is a rate-limiting operator, because it is impossible for more than one value to be emitted in any time window of duration dueTime, but it is also a delay-like operator since output emissions do not occur at the same time as they did on the source Observable. Optionally takes a {@link IScheduler} for managing timers.

Parameters :
Name Type Optional Description
this typeReference
dueTime number

The timeout duration in milliseconds (or the time unit determined internally by the optional scheduler) for the window of time required to wait for emission silence before emitting the most recent source value.

scheduler typeReference

The {

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounceTime(1000); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/debounceTime.ts

debounceTime
debounceTime(dueTime: number, scheduler: typeReference)

Emits a value from the source Observable only after a particular time span has passed without another source emission.

It's like {@link delay}, but passes only the most recent value from each burst of emissions.

debounceTime delays values emitted by the source Observable, but drops previous pending delayed emissions if a new value arrives on the source Observable. This operator keeps track of the most recent value from the source Observable, and emits that only when dueTime enough time has passed without any other value appearing on the source Observable. If a new value appears before dueTime silence occurs, the previous value will be dropped and will not be emitted on the output Observable.

This is a rate-limiting operator, because it is impossible for more than one value to be emitted in any time window of duration dueTime, but it is also a delay-like operator since output emissions do not occur at the same time as they did on the source Observable. Optionally takes a {@link IScheduler} for managing timers.

Parameters :
Name Type Optional Description
dueTime number

The timeout duration in milliseconds (or the time unit determined internally by the optional scheduler) for the window of time required to wait for emission silence before emitting the most recent source value.

scheduler typeReference

The {

Example :

Emit the most recent click after a burst of clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.debounceTime(1000); result.subscribe(x => console.log(x));

dispatchNext
dispatchNext(subscriber: typeReference)
Parameters :
Name Type Optional Description
subscriber typeReference

node_modules_/rxjs/src/operator/defaultIfEmpty.ts

defaultIfEmpty
defaultIfEmpty(this: typeReference, defaultValue: typeReference)

Emits a given value if the source Observable completes without emitting any next value, otherwise mirrors the source Observable.

If the source Observable turns out to be empty, then this operator will emit a default value.

defaultIfEmpty emits the values emitted by the source Observable or a specified default value if the source Observable is empty (completes without having emitted any next value).

Parameters :
Name Type Optional Description
this typeReference
defaultValue typeReference

The default value used if the source Observable is empty.

Example :

If no clicks happen in 5 seconds, then emit "no clicks" var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksBeforeFive = clicks.takeUntil(Rx.Observable.interval(5000)); var result = clicksBeforeFive.defaultIfEmpty('no clicks'); result.subscribe(x => console.log(x));

defaultIfEmpty
defaultIfEmpty(this: typeReference, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
defaultValue typeReference true
defaultIfEmpty
defaultIfEmpty(this: typeReference, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
defaultValue typeReference true

node_modules_/rxjs/src/operators/defaultIfEmpty.ts

defaultIfEmpty
defaultIfEmpty(defaultValue: typeReference)

Emits a given value if the source Observable completes without emitting any next value, otherwise mirrors the source Observable.

If the source Observable turns out to be empty, then this operator will emit a default value.

defaultIfEmpty emits the values emitted by the source Observable or a specified default value if the source Observable is empty (completes without having emitted any next value).

Parameters :
Name Type Optional Description
defaultValue typeReference

The default value used if the source Observable is empty.

Example :

If no clicks happen in 5 seconds, then emit "no clicks" var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksBeforeFive = clicks.takeUntil(Rx.Observable.interval(5000)); var result = clicksBeforeFive.defaultIfEmpty('no clicks'); result.subscribe(x => console.log(x));

defaultIfEmpty
defaultIfEmpty(defaultValue?: typeReference)
Parameters :
Name Type Optional Description
defaultValue typeReference true
defaultIfEmpty
defaultIfEmpty(defaultValue?: typeReference)
Parameters :
Name Type Optional Description
defaultValue typeReference true

node_modules__/rxjs/src/operators/defaultIfEmpty.ts

defaultIfEmpty
defaultIfEmpty(defaultValue: typeReference)

Emits a given value if the source Observable completes without emitting any next value, otherwise mirrors the source Observable.

If the source Observable turns out to be empty, then this operator will emit a default value.

defaultIfEmpty emits the values emitted by the source Observable or a specified default value if the source Observable is empty (completes without having emitted any next value).

Parameters :
Name Type Optional Description
defaultValue typeReference

The default value used if the source Observable is empty.

Example :

If no clicks happen in 5 seconds, then emit "no clicks" var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksBeforeFive = clicks.takeUntil(Rx.Observable.interval(5000)); var result = clicksBeforeFive.defaultIfEmpty('no clicks'); result.subscribe(x => console.log(x));

defaultIfEmpty
defaultIfEmpty(defaultValue?: typeReference)
Parameters :
Name Type Optional Description
defaultValue typeReference true
defaultIfEmpty
defaultIfEmpty(defaultValue?: typeReference)
Parameters :
Name Type Optional Description
defaultValue typeReference true

node_modules__/rxjs/src/operator/defaultIfEmpty.ts

defaultIfEmpty
defaultIfEmpty(this: typeReference, defaultValue: typeReference)

Emits a given value if the source Observable completes without emitting any next value, otherwise mirrors the source Observable.

If the source Observable turns out to be empty, then this operator will emit a default value.

defaultIfEmpty emits the values emitted by the source Observable or a specified default value if the source Observable is empty (completes without having emitted any next value).

Parameters :
Name Type Optional Description
this typeReference
defaultValue typeReference

The default value used if the source Observable is empty.

Example :

If no clicks happen in 5 seconds, then emit "no clicks" var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksBeforeFive = clicks.takeUntil(Rx.Observable.interval(5000)); var result = clicksBeforeFive.defaultIfEmpty('no clicks'); result.subscribe(x => console.log(x));

defaultIfEmpty
defaultIfEmpty(this: typeReference, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
defaultValue typeReference true
defaultIfEmpty
defaultIfEmpty(this: typeReference, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
defaultValue typeReference true

node_modules__/rxjs/src/operators/delay.ts

delay
delay(delay: undefined, scheduler: typeReference)

Delays the emission of items from the source Observable by a given timeout or until a given Date.

Time shifts each item by some specified amount of milliseconds.

If the delay argument is a Number, this operator time shifts the source Observable by that amount of time expressed in milliseconds. The relative time intervals between the values are preserved.

If the delay argument is a Date, this operator time shifts the start of the Observable execution until the given date occurs.

Parameters :
Name Type Optional Description
delay

The delay duration in milliseconds (a number) or a Date until which the emission of the source items is delayed.

scheduler typeReference

The IScheduler to use for managing the timers that handle the time-shift for each item.

Example :

Delay each click by one second var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delay(1000); // each click emitted after 1 second delayedClicks.subscribe(x => console.log(x));

Delay all clicks until a future date happens var clicks = Rx.Observable.fromEvent(document, 'click'); var date = new Date('March 15, 2050 12:00:00'); // in the future var delayedClicks = clicks.delay(date); // click emitted only after that date delayedClicks.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/delay.ts

delay
delay(this: typeReference, delay: undefined, scheduler: typeReference)

Delays the emission of items from the source Observable by a given timeout or until a given Date.

Time shifts each item by some specified amount of milliseconds.

If the delay argument is a Number, this operator time shifts the source Observable by that amount of time expressed in milliseconds. The relative time intervals between the values are preserved.

If the delay argument is a Date, this operator time shifts the start of the Observable execution until the given date occurs.

Parameters :
Name Type Optional Description
this typeReference
delay

The delay duration in milliseconds (a number) or a Date until which the emission of the source items is delayed.

scheduler typeReference

The IScheduler to use for managing the timers that handle the time-shift for each item.

Example :

Delay each click by one second var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delay(1000); // each click emitted after 1 second delayedClicks.subscribe(x => console.log(x));

Delay all clicks until a future date happens var clicks = Rx.Observable.fromEvent(document, 'click'); var date = new Date('March 15, 2050 12:00:00'); // in the future var delayedClicks = clicks.delay(date); // click emitted only after that date delayedClicks.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/delay.ts

delay
delay(delay: undefined, scheduler: typeReference)

Delays the emission of items from the source Observable by a given timeout or until a given Date.

Time shifts each item by some specified amount of milliseconds.

If the delay argument is a Number, this operator time shifts the source Observable by that amount of time expressed in milliseconds. The relative time intervals between the values are preserved.

If the delay argument is a Date, this operator time shifts the start of the Observable execution until the given date occurs.

Parameters :
Name Type Optional Description
delay

The delay duration in milliseconds (a number) or a Date until which the emission of the source items is delayed.

scheduler typeReference

The IScheduler to use for managing the timers that handle the time-shift for each item.

Example :

Delay each click by one second var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delay(1000); // each click emitted after 1 second delayedClicks.subscribe(x => console.log(x));

Delay all clicks until a future date happens var clicks = Rx.Observable.fromEvent(document, 'click'); var date = new Date('March 15, 2050 12:00:00'); // in the future var delayedClicks = clicks.delay(date); // click emitted only after that date delayedClicks.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/delay.ts

delay
delay(this: typeReference, delay: undefined, scheduler: typeReference)

Delays the emission of items from the source Observable by a given timeout or until a given Date.

Time shifts each item by some specified amount of milliseconds.

If the delay argument is a Number, this operator time shifts the source Observable by that amount of time expressed in milliseconds. The relative time intervals between the values are preserved.

If the delay argument is a Date, this operator time shifts the start of the Observable execution until the given date occurs.

Parameters :
Name Type Optional Description
this typeReference
delay

The delay duration in milliseconds (a number) or a Date until which the emission of the source items is delayed.

scheduler typeReference

The IScheduler to use for managing the timers that handle the time-shift for each item.

Example :

Delay each click by one second var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delay(1000); // each click emitted after 1 second delayedClicks.subscribe(x => console.log(x));

Delay all clicks until a future date happens var clicks = Rx.Observable.fromEvent(document, 'click'); var date = new Date('March 15, 2050 12:00:00'); // in the future var delayedClicks = clicks.delay(date); // click emitted only after that date delayedClicks.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/delayWhen.ts

delayWhen
delayWhen(this: typeReference, delayDurationSelector: undefined, subscriptionDelay?: typeReference)

Delays the emission of items from the source Observable by a given time span determined by the emissions of another Observable.

It's like {@link delay}, but the time span of the delay duration is determined by a second Observable.

delayWhen time shifts each emitted value from the source Observable by a time span determined by another Observable. When the source emits a value, the delayDurationSelector function is called with the source value as argument, and should return an Observable, called the "duration" Observable. The source value is emitted on the output Observable only when the duration Observable emits a value or completes.

Optionally, delayWhen takes a second argument, subscriptionDelay, which is an Observable. When subscriptionDelay emits its first value or completes, the source Observable is subscribed to and starts behaving like described in the previous paragraph. If subscriptionDelay is not provided, delayWhen will subscribe to the source Observable as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
this typeReference
delayDurationSelector

A function that returns an Observable for each value emitted by the source Observable, which is then used to delay the emission of that item on the output Observable until the Observable returned from this function emits a value.

subscriptionDelay typeReference true

An Observable that triggers the subscription to the source Observable once it emits any value.

Example :

Delay each click by a random amount of time, between 0 and 5 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delayWhen(event => Rx.Observable.interval(Math.random() * 5000) ); delayedClicks.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/delayWhen.ts

delayWhen
delayWhen(delayDurationSelector: undefined, subscriptionDelay?: typeReference)

Delays the emission of items from the source Observable by a given time span determined by the emissions of another Observable.

It's like {@link delay}, but the time span of the delay duration is determined by a second Observable.

delayWhen time shifts each emitted value from the source Observable by a time span determined by another Observable. When the source emits a value, the delayDurationSelector function is called with the source value as argument, and should return an Observable, called the "duration" Observable. The source value is emitted on the output Observable only when the duration Observable emits a value or completes.

Optionally, delayWhen takes a second argument, subscriptionDelay, which is an Observable. When subscriptionDelay emits its first value or completes, the source Observable is subscribed to and starts behaving like described in the previous paragraph. If subscriptionDelay is not provided, delayWhen will subscribe to the source Observable as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
delayDurationSelector

A function that returns an Observable for each value emitted by the source Observable, which is then used to delay the emission of that item on the output Observable until the Observable returned from this function emits a value.

subscriptionDelay typeReference true

An Observable that triggers the subscription to the source Observable once it emits any value.

Example :

Delay each click by a random amount of time, between 0 and 5 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delayWhen(event => Rx.Observable.interval(Math.random() * 5000) ); delayedClicks.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/delayWhen.ts

delayWhen
delayWhen(delayDurationSelector: undefined, subscriptionDelay?: typeReference)

Delays the emission of items from the source Observable by a given time span determined by the emissions of another Observable.

It's like {@link delay}, but the time span of the delay duration is determined by a second Observable.

delayWhen time shifts each emitted value from the source Observable by a time span determined by another Observable. When the source emits a value, the delayDurationSelector function is called with the source value as argument, and should return an Observable, called the "duration" Observable. The source value is emitted on the output Observable only when the duration Observable emits a value or completes.

Optionally, delayWhen takes a second argument, subscriptionDelay, which is an Observable. When subscriptionDelay emits its first value or completes, the source Observable is subscribed to and starts behaving like described in the previous paragraph. If subscriptionDelay is not provided, delayWhen will subscribe to the source Observable as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
delayDurationSelector

A function that returns an Observable for each value emitted by the source Observable, which is then used to delay the emission of that item on the output Observable until the Observable returned from this function emits a value.

subscriptionDelay typeReference true

An Observable that triggers the subscription to the source Observable once it emits any value.

Example :

Delay each click by a random amount of time, between 0 and 5 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delayWhen(event => Rx.Observable.interval(Math.random() * 5000) ); delayedClicks.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/delayWhen.ts

delayWhen
delayWhen(this: typeReference, delayDurationSelector: undefined, subscriptionDelay?: typeReference)

Delays the emission of items from the source Observable by a given time span determined by the emissions of another Observable.

It's like {@link delay}, but the time span of the delay duration is determined by a second Observable.

delayWhen time shifts each emitted value from the source Observable by a time span determined by another Observable. When the source emits a value, the delayDurationSelector function is called with the source value as argument, and should return an Observable, called the "duration" Observable. The source value is emitted on the output Observable only when the duration Observable emits a value or completes.

Optionally, delayWhen takes a second argument, subscriptionDelay, which is an Observable. When subscriptionDelay emits its first value or completes, the source Observable is subscribed to and starts behaving like described in the previous paragraph. If subscriptionDelay is not provided, delayWhen will subscribe to the source Observable as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
this typeReference
delayDurationSelector

A function that returns an Observable for each value emitted by the source Observable, which is then used to delay the emission of that item on the output Observable until the Observable returned from this function emits a value.

subscriptionDelay typeReference true

An Observable that triggers the subscription to the source Observable once it emits any value.

Example :

Delay each click by a random amount of time, between 0 and 5 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delayWhen(event => Rx.Observable.interval(Math.random() * 5000) ); delayedClicks.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/dematerialize.ts

dematerialize
dematerialize(this: typeReference)

Converts an Observable of Notification objects into the emissions that they represent.

Unwraps Notification objects as actual next, error and complete emissions. The opposite of {@link materialize}.

dematerialize is assumed to operate an Observable that only emits {@link Notification} objects as next emissions, and does not emit any error. Such Observable is the output of a materialize operation. Those notifications are then unwrapped using the metadata they contain, and emitted as next, error, and complete on the output Observable.

Use this operator in conjunction with {@link materialize}.

Parameters :
Name Type Optional Description
this typeReference
Example :

Convert an Observable of Notifications to an actual Observable var notifA = new Rx.Notification('N', 'A'); var notifB = new Rx.Notification('N', 'B'); var notifE = new Rx.Notification('E', void 0, new TypeError('x.toUpperCase is not a function') ); var materialized = Rx.Observable.of(notifA, notifB, notifE); var upperCase = materialized.dematerialize(); upperCase.subscribe(x => console.log(x), e => console.error(e));

// Results in: // A // B // TypeError: x.toUpperCase is not a function

node_modules__/rxjs/src/operator/dematerialize.ts

dematerialize
dematerialize(this: typeReference)

Converts an Observable of Notification objects into the emissions that they represent.

Unwraps Notification objects as actual next, error and complete emissions. The opposite of {@link materialize}.

dematerialize is assumed to operate an Observable that only emits {@link Notification} objects as next emissions, and does not emit any error. Such Observable is the output of a materialize operation. Those notifications are then unwrapped using the metadata they contain, and emitted as next, error, and complete on the output Observable.

Use this operator in conjunction with {@link materialize}.

Parameters :
Name Type Optional Description
this typeReference
Example :

Convert an Observable of Notifications to an actual Observable var notifA = new Rx.Notification('N', 'A'); var notifB = new Rx.Notification('N', 'B'); var notifE = new Rx.Notification('E', void 0, new TypeError('x.toUpperCase is not a function') ); var materialized = Rx.Observable.of(notifA, notifB, notifE); var upperCase = materialized.dematerialize(); upperCase.subscribe(x => console.log(x), e => console.error(e));

// Results in: // A // B // TypeError: x.toUpperCase is not a function

node_modules_/rxjs/src/operators/dematerialize.ts

dematerialize
dematerialize()

Converts an Observable of Notification objects into the emissions that they represent.

Unwraps Notification objects as actual next, error and complete emissions. The opposite of {@link materialize}.

dematerialize is assumed to operate an Observable that only emits {@link Notification} objects as next emissions, and does not emit any error. Such Observable is the output of a materialize operation. Those notifications are then unwrapped using the metadata they contain, and emitted as next, error, and complete on the output Observable.

Use this operator in conjunction with {@link materialize}.

Example :

Convert an Observable of Notifications to an actual Observable var notifA = new Rx.Notification('N', 'A'); var notifB = new Rx.Notification('N', 'B'); var notifE = new Rx.Notification('E', void 0, new TypeError('x.toUpperCase is not a function') ); var materialized = Rx.Observable.of(notifA, notifB, notifE); var upperCase = materialized.dematerialize(); upperCase.subscribe(x => console.log(x), e => console.error(e));

// Results in: // A // B // TypeError: x.toUpperCase is not a function

node_modules__/rxjs/src/operators/dematerialize.ts

dematerialize
dematerialize()

Converts an Observable of Notification objects into the emissions that they represent.

Unwraps Notification objects as actual next, error and complete emissions. The opposite of {@link materialize}.

dematerialize is assumed to operate an Observable that only emits {@link Notification} objects as next emissions, and does not emit any error. Such Observable is the output of a materialize operation. Those notifications are then unwrapped using the metadata they contain, and emitted as next, error, and complete on the output Observable.

Use this operator in conjunction with {@link materialize}.

Example :

Convert an Observable of Notifications to an actual Observable var notifA = new Rx.Notification('N', 'A'); var notifB = new Rx.Notification('N', 'B'); var notifE = new Rx.Notification('E', void 0, new TypeError('x.toUpperCase is not a function') ); var materialized = Rx.Observable.of(notifA, notifB, notifE); var upperCase = materialized.dematerialize(); upperCase.subscribe(x => console.log(x), e => console.error(e));

// Results in: // A // B // TypeError: x.toUpperCase is not a function

node_modules__/rxjs/src/observable/BoundNodeCallbackObservable.ts

dispatch
dispatch(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
dispatchError
dispatchError(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference

node_modules__/rxjs/src/observable/PairsObservable.ts

dispatch
dispatch(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference

node_modules_/rxjs/src/observable/PairsObservable.ts

dispatch
dispatch(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference

node_modules_/rxjs/src/observable/BoundNodeCallbackObservable.ts

dispatch
dispatch(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
dispatchError
dispatchError(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference

node_modules_/rxjs/src/observable/PromiseObservable.ts

dispatchError
dispatchError(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference

node_modules_/rxjs/src/observable/BoundCallbackObservable.ts

dispatchError
dispatchError(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference

node_modules__/rxjs/src/observable/BoundCallbackObservable.ts

dispatchError
dispatchError(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference

node_modules__/rxjs/src/observable/PromiseObservable.ts

dispatchError
dispatchError(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference

node_modules__/rxjs/src/operators/throttleTime.ts

dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
throttleTime
throttleTime(duration: number, scheduler: typeReference, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for duration milliseconds, then repeats this process.

Lets a value pass, then ignores source values for the next duration milliseconds.

throttleTime emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
duration number

Time to wait before emitting another value after emitting the last value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

config typeReference
Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttleTime(1000); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/throttleTime.ts

dispatchNext
dispatchNext(arg: typeReference)
Parameters :
Name Type Optional Description
arg typeReference
throttleTime
throttleTime(duration: number, scheduler: typeReference, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for duration milliseconds, then repeats this process.

Lets a value pass, then ignores source values for the next duration milliseconds.

throttleTime emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
duration number

Time to wait before emitting another value after emitting the last value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

config typeReference
Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttleTime(1000); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/sampleTime.ts

dispatchNotification
dispatchNotification(this: typeReference, state: any)
Parameters :
Name Type Optional Description
this typeReference
state any
sampleTime
sampleTime(period: number, scheduler: typeReference)

Emits the most recently emitted value from the source Observable within periodic time intervals.

Samples the source Observable at periodic time intervals, emitting what it samples.

sampleTime periodically looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The sampling happens periodically in time every period milliseconds (or the time unit defined by the optional scheduler argument). The sampling starts as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
period number

The sampling period expressed in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Every second, emit the most recent click at most once var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.sampleTime(1000); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/sampleTime.ts

dispatchNotification
dispatchNotification(this: typeReference, state: any)
Parameters :
Name Type Optional Description
this typeReference
state any
sampleTime
sampleTime(period: number, scheduler: typeReference)

Emits the most recently emitted value from the source Observable within periodic time intervals.

Samples the source Observable at periodic time intervals, emitting what it samples.

sampleTime periodically looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The sampling happens periodically in time every period milliseconds (or the time unit defined by the optional scheduler argument). The sampling starts as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
period number

The sampling period expressed in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Every second, emit the most recent click at most once var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.sampleTime(1000); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/windowTime.ts

dispatchWindowClose
dispatchWindowClose(state: typeReference)
Parameters :
Name Type Optional Description
state typeReference
dispatchWindowCreation
dispatchWindowCreation(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
dispatchWindowTimeSpanOnly
dispatchWindowTimeSpanOnly(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
windowTime
windowTime(windowTimeSpan: number, scheduler?: typeReference)

Branch out the source Observable values as a nested Observable periodically in time.

It's like {@link bufferTime}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable starts a new window periodically, as determined by the windowCreationInterval argument. It emits each window after a fixed timespan, specified by the windowTimeSpan argument. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If windowCreationInterval is not provided, the output Observable starts a new window when the previous window of duration windowTimeSpan completes. If maxWindowCount is provided, each window will emit at most fixed number of values. Window will complete immediately after emitting last value and next one still will open as specified by windowTimeSpan and windowCreationInterval arguments.

Parameters :
Name Type Optional Description
windowTimeSpan number

The amount of time to fill each window.

scheduler typeReference true

The scheduler on which to schedule the intervals that determine window boundaries.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Every 5 seconds start a window 1 second long, and emit at most 2 click events per window var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Same as example above but with maxWindowCount instead of take var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000, 2) // each window has still at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

windowTime
windowTime(windowTimeSpan: number, windowCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
windowTimeSpan number
windowCreationInterval number
scheduler typeReference true
windowTime
windowTime(windowTimeSpan: number, windowCreationInterval: number, maxWindowSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
windowTimeSpan number
windowCreationInterval number
maxWindowSize number
scheduler typeReference true
windowTime
windowTime(windowTimeSpan: number)
Parameters :
Name Type Optional Description
windowTimeSpan number

node_modules__/rxjs/src/operators/windowTime.ts

dispatchWindowClose
dispatchWindowClose(state: typeReference)
Parameters :
Name Type Optional Description
state typeReference
dispatchWindowCreation
dispatchWindowCreation(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
dispatchWindowTimeSpanOnly
dispatchWindowTimeSpanOnly(this: typeReference, state: typeReference)
Parameters :
Name Type Optional Description
this typeReference
state typeReference
windowTime
windowTime(windowTimeSpan: number, windowCreationInterval: number, maxWindowSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
windowTimeSpan number
windowCreationInterval number
maxWindowSize number
scheduler typeReference true
windowTime
windowTime(windowTimeSpan: number, windowCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
windowTimeSpan number
windowCreationInterval number
scheduler typeReference true
windowTime
windowTime(windowTimeSpan: number, scheduler?: typeReference)

Branch out the source Observable values as a nested Observable periodically in time.

It's like {@link bufferTime}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable starts a new window periodically, as determined by the windowCreationInterval argument. It emits each window after a fixed timespan, specified by the windowTimeSpan argument. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If windowCreationInterval is not provided, the output Observable starts a new window when the previous window of duration windowTimeSpan completes. If maxWindowCount is provided, each window will emit at most fixed number of values. Window will complete immediately after emitting last value and next one still will open as specified by windowTimeSpan and windowCreationInterval arguments.

Parameters :
Name Type Optional Description
windowTimeSpan number

The amount of time to fill each window.

scheduler typeReference true

The scheduler on which to schedule the intervals that determine window boundaries.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Every 5 seconds start a window 1 second long, and emit at most 2 click events per window var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Same as example above but with maxWindowCount instead of take var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000, 2) // each window has still at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

windowTime
windowTime(windowTimeSpan: number)
Parameters :
Name Type Optional Description
windowTimeSpan number

node_modules_/rxjs/src/operator/distinct.ts

distinct
distinct(this: typeReference, keySelector?: undefined, flushes?: typeReference)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items.

If a keySelector function is provided, then it will project each value from the source observable into a new value that it will check for equality with previously projected values. If a keySelector function is not provided, it will use each value from the source observable directly with an equality check against previous values.

In JavaScript runtimes that support Set, this operator will use a Set to improve performance of the distinct value checking.

In other runtimes, this operator will use a minimal implementation of Set that relies on an Array and indexOf under the hood, so performance will degrade as more values are checked for distinction. Even in newer browsers, a long-running distinct use might result in memory leaks. To help alleviate this in some scenarios, an optional flushes parameter is also provided so that the internal Set can be "flushed", basically clearing it of values.

Parameters :
Name Type Optional Description
this typeReference
keySelector true

Optional function to select which value you want to check as distinct.

flushes typeReference true

Optional Observable for flushing the internal HashSet of the operator.

Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 2, 3, 4, 3, 2, 1) .distinct() .subscribe(x => console.log(x)); // 1, 2, 3, 4

An example using a keySelector function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) .distinct((p: Person) => p.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' }

node_modules__/rxjs/src/operators/distinct.ts

distinct
distinct(keySelector?: undefined, flushes?: typeReference)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items.

If a keySelector function is provided, then it will project each value from the source observable into a new value that it will check for equality with previously projected values. If a keySelector function is not provided, it will use each value from the source observable directly with an equality check against previous values.

In JavaScript runtimes that support Set, this operator will use a Set to improve performance of the distinct value checking.

In other runtimes, this operator will use a minimal implementation of Set that relies on an Array and indexOf under the hood, so performance will degrade as more values are checked for distinction. Even in newer browsers, a long-running distinct use might result in memory leaks. To help alleviate this in some scenarios, an optional flushes parameter is also provided so that the internal Set can be "flushed", basically clearing it of values.

Parameters :
Name Type Optional Description
keySelector true

Optional function to select which value you want to check as distinct.

flushes typeReference true

Optional Observable for flushing the internal HashSet of the operator.

Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 2, 3, 4, 3, 2, 1) .distinct() .subscribe(x => console.log(x)); // 1, 2, 3, 4

An example using a keySelector function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) .distinct((p: Person) => p.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' }

node_modules__/rxjs/src/operator/distinct.ts

distinct
distinct(this: typeReference, keySelector?: undefined, flushes?: typeReference)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items.

If a keySelector function is provided, then it will project each value from the source observable into a new value that it will check for equality with previously projected values. If a keySelector function is not provided, it will use each value from the source observable directly with an equality check against previous values.

In JavaScript runtimes that support Set, this operator will use a Set to improve performance of the distinct value checking.

In other runtimes, this operator will use a minimal implementation of Set that relies on an Array and indexOf under the hood, so performance will degrade as more values are checked for distinction. Even in newer browsers, a long-running distinct use might result in memory leaks. To help alleviate this in some scenarios, an optional flushes parameter is also provided so that the internal Set can be "flushed", basically clearing it of values.

Parameters :
Name Type Optional Description
this typeReference
keySelector true

Optional function to select which value you want to check as distinct.

flushes typeReference true

Optional Observable for flushing the internal HashSet of the operator.

Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 2, 3, 4, 3, 2, 1) .distinct() .subscribe(x => console.log(x)); // 1, 2, 3, 4

An example using a keySelector function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) .distinct((p: Person) => p.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' }

node_modules_/rxjs/src/operators/distinct.ts

distinct
distinct(keySelector?: undefined, flushes?: typeReference)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items.

If a keySelector function is provided, then it will project each value from the source observable into a new value that it will check for equality with previously projected values. If a keySelector function is not provided, it will use each value from the source observable directly with an equality check against previous values.

In JavaScript runtimes that support Set, this operator will use a Set to improve performance of the distinct value checking.

In other runtimes, this operator will use a minimal implementation of Set that relies on an Array and indexOf under the hood, so performance will degrade as more values are checked for distinction. Even in newer browsers, a long-running distinct use might result in memory leaks. To help alleviate this in some scenarios, an optional flushes parameter is also provided so that the internal Set can be "flushed", basically clearing it of values.

Parameters :
Name Type Optional Description
keySelector true

Optional function to select which value you want to check as distinct.

flushes typeReference true

Optional Observable for flushing the internal HashSet of the operator.

Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 2, 3, 4, 3, 2, 1) .distinct() .subscribe(x => console.log(x)); // 1, 2, 3, 4

An example using a keySelector function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) .distinct((p: Person) => p.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' }

node_modules__/rxjs/src/operators/distinctUntilChanged.ts

distinctUntilChanged
distinctUntilChanged(compare?: undefined)
Parameters :
Name Type Optional Description
compare true
distinctUntilChanged
distinctUntilChanged(compare?: undefined, keySelector?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

keySelector true
Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 1, 2, 3, 3, 4) .distinctUntilChanged() .subscribe(x => console.log(x)); // 1, 2, 1, 2, 3, 4

An example using a compare function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) { age: 6, name: 'Foo'}) .distinctUntilChanged((p: Person, q: Person) => p.name === q.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

distinctUntilChanged
distinctUntilChanged(compare: undefined, keySelector: undefined)
Parameters :
Name Type Optional Description
compare
keySelector

node_modules_/rxjs/src/operator/distinctUntilChanged.ts

distinctUntilChanged
distinctUntilChanged(this: typeReference, compare?: undefined)
Parameters :
Name Type Optional Description
this typeReference
compare true
distinctUntilChanged
distinctUntilChanged(this: typeReference, compare: undefined, keySelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
compare
keySelector
distinctUntilChanged
distinctUntilChanged(this: typeReference, compare?: undefined, keySelector?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
this typeReference
compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

keySelector true
Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 1, 2, 3, 3, 4) .distinctUntilChanged() .subscribe(x => console.log(x)); // 1, 2, 1, 2, 3, 4

An example using a compare function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) { age: 6, name: 'Foo'}) .distinctUntilChanged((p: Person, q: Person) => p.name === q.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

node_modules__/rxjs/src/operator/distinctUntilChanged.ts

distinctUntilChanged
distinctUntilChanged(this: typeReference, compare?: undefined, keySelector?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
this typeReference
compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

keySelector true
Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 1, 2, 3, 3, 4) .distinctUntilChanged() .subscribe(x => console.log(x)); // 1, 2, 1, 2, 3, 4

An example using a compare function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) { age: 6, name: 'Foo'}) .distinctUntilChanged((p: Person, q: Person) => p.name === q.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

distinctUntilChanged
distinctUntilChanged(this: typeReference, compare: undefined, keySelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
compare
keySelector
distinctUntilChanged
distinctUntilChanged(this: typeReference, compare?: undefined)
Parameters :
Name Type Optional Description
this typeReference
compare true

node_modules_/rxjs/src/operators/distinctUntilChanged.ts

distinctUntilChanged
distinctUntilChanged(compare?: undefined)
Parameters :
Name Type Optional Description
compare true
distinctUntilChanged
distinctUntilChanged(compare: undefined, keySelector: undefined)
Parameters :
Name Type Optional Description
compare
keySelector
distinctUntilChanged
distinctUntilChanged(compare?: undefined, keySelector?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

keySelector true
Example :

A simple example with numbers Observable.of(1, 1, 2, 2, 2, 1, 1, 2, 3, 3, 4) .distinctUntilChanged() .subscribe(x => console.log(x)); // 1, 2, 1, 2, 3, 4

An example using a compare function interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}) { age: 6, name: 'Foo'}) .distinctUntilChanged((p: Person, q: Person) => p.name === q.name) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

node_modules__/rxjs/src/operators/distinctUntilKeyChanged.ts

distinctUntilKeyChanged
distinctUntilKeyChanged(key: string)
Parameters :
Name Type Optional Description
key string
distinctUntilKeyChanged
distinctUntilKeyChanged(key: string, compare: undefined)
Parameters :
Name Type Optional Description
key string
compare
distinctUntilKeyChanged
distinctUntilKeyChanged(key: string, compare?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item, using a property accessed by using the key provided to check if the two items are distinct.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
key string

String key for object property lookup on each item.

compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

Example :
An example comparing the name of persons

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}, { age: 6, name: 'Foo'}) .distinctUntilKeyChanged('name') .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

An example comparing the first letters of the name

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo1'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo2'}, { age: 6, name: 'Foo3'}) .distinctUntilKeyChanged('name', (x: string, y: string) => x.substring(0, 3) === y.substring(0, 3)) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo1' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo2' }

node_modules_/rxjs/src/operator/distinctUntilKeyChanged.ts

distinctUntilKeyChanged
distinctUntilKeyChanged(this: typeReference, key: string, compare: undefined)
Parameters :
Name Type Optional Description
this typeReference
key string
compare
distinctUntilKeyChanged
distinctUntilKeyChanged(this: typeReference, key: string, compare?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item, using a property accessed by using the key provided to check if the two items are distinct.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
this typeReference
key string

String key for object property lookup on each item.

compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

Example :
An example comparing the name of persons

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}, { age: 6, name: 'Foo'}) .distinctUntilKeyChanged('name') .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

An example comparing the first letters of the name

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo1'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo2'}, { age: 6, name: 'Foo3'}) .distinctUntilKeyChanged('name', (x: string, y: string) => x.substring(0, 3) === y.substring(0, 3)) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo1' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo2' }

distinctUntilKeyChanged
distinctUntilKeyChanged(this: typeReference, key: string)
Parameters :
Name Type Optional Description
this typeReference
key string

node_modules__/rxjs/src/operator/distinctUntilKeyChanged.ts

distinctUntilKeyChanged
distinctUntilKeyChanged(this: typeReference, key: string)
Parameters :
Name Type Optional Description
this typeReference
key string
distinctUntilKeyChanged
distinctUntilKeyChanged(this: typeReference, key: string, compare: undefined)
Parameters :
Name Type Optional Description
this typeReference
key string
compare
distinctUntilKeyChanged
distinctUntilKeyChanged(this: typeReference, key: string, compare?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item, using a property accessed by using the key provided to check if the two items are distinct.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
this typeReference
key string

String key for object property lookup on each item.

compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

Example :
An example comparing the name of persons

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}, { age: 6, name: 'Foo'}) .distinctUntilKeyChanged('name') .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

An example comparing the first letters of the name

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo1'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo2'}, { age: 6, name: 'Foo3'}) .distinctUntilKeyChanged('name', (x: string, y: string) => x.substring(0, 3) === y.substring(0, 3)) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo1' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo2' }

node_modules_/rxjs/src/operators/distinctUntilKeyChanged.ts

distinctUntilKeyChanged
distinctUntilKeyChanged(key: string, compare?: undefined)

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item, using a property accessed by using the key provided to check if the two items are distinct.

If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted.

If a comparator function is not provided, an equality check is used by default.

Parameters :
Name Type Optional Description
key string

String key for object property lookup on each item.

compare true

Optional comparison function called to test if an item is distinct from the previous item in the source.

Example :
An example comparing the name of persons

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo'}, { age: 6, name: 'Foo'}) .distinctUntilKeyChanged('name') .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo' }

An example comparing the first letters of the name

interface Person { age: number, name: string }

Observable.of( { age: 4, name: 'Foo1'}, { age: 7, name: 'Bar'}, { age: 5, name: 'Foo2'}, { age: 6, name: 'Foo3'}) .distinctUntilKeyChanged('name', (x: string, y: string) => x.substring(0, 3) === y.substring(0, 3)) .subscribe(x => console.log(x));

// displays: // { age: 4, name: 'Foo1' } // { age: 7, name: 'Bar' } // { age: 5, name: 'Foo2' }

distinctUntilKeyChanged
distinctUntilKeyChanged(key: string)
Parameters :
Name Type Optional Description
key string
distinctUntilKeyChanged
distinctUntilKeyChanged(key: string, compare: undefined)
Parameters :
Name Type Optional Description
key string
compare

node_modules__/rxjs/src/operator/elementAt.ts

elementAt
elementAt(this: typeReference, index: number, defaultValue?: typeReference)

Emits the single value at the specified index in a sequence of emissions from the source Observable.

Emits only the i-th value, then completes.

elementAt returns an Observable that emits the item at the specified index in the source Observable, or a default value if that index is out of range and the default argument is provided. If the default argument is not given and the index is out of range, the output Observable will emit an ArgumentOutOfRangeError error.

Parameters :
Name Type Optional Description
this typeReference
index number

Is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

defaultValue typeReference true

The default value returned for missing indices.

Example :

Emit only the third click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.elementAt(2); result.subscribe(x => console.log(x));

// Results in: // click 1 = nothing // click 2 = nothing // click 3 = MouseEvent object logged to console

node_modules__/rxjs/src/operators/elementAt.ts

elementAt
elementAt(index: number, defaultValue?: typeReference)

Emits the single value at the specified index in a sequence of emissions from the source Observable.

Emits only the i-th value, then completes.

elementAt returns an Observable that emits the item at the specified index in the source Observable, or a default value if that index is out of range and the default argument is provided. If the default argument is not given and the index is out of range, the output Observable will emit an ArgumentOutOfRangeError error.

Parameters :
Name Type Optional Description
index number

Is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

defaultValue typeReference true

The default value returned for missing indices.

Example :

Emit only the third click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.elementAt(2); result.subscribe(x => console.log(x));

// Results in: // click 1 = nothing // click 2 = nothing // click 3 = MouseEvent object logged to console

node_modules_/rxjs/src/operators/elementAt.ts

elementAt
elementAt(index: number, defaultValue?: typeReference)

Emits the single value at the specified index in a sequence of emissions from the source Observable.

Emits only the i-th value, then completes.

elementAt returns an Observable that emits the item at the specified index in the source Observable, or a default value if that index is out of range and the default argument is provided. If the default argument is not given and the index is out of range, the output Observable will emit an ArgumentOutOfRangeError error.

Parameters :
Name Type Optional Description
index number

Is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

defaultValue typeReference true

The default value returned for missing indices.

Example :

Emit only the third click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.elementAt(2); result.subscribe(x => console.log(x));

// Results in: // click 1 = nothing // click 2 = nothing // click 3 = MouseEvent object logged to console

node_modules_/rxjs/src/operator/elementAt.ts

elementAt
elementAt(this: typeReference, index: number, defaultValue?: typeReference)

Emits the single value at the specified index in a sequence of emissions from the source Observable.

Emits only the i-th value, then completes.

elementAt returns an Observable that emits the item at the specified index in the source Observable, or a default value if that index is out of range and the default argument is provided. If the default argument is not given and the index is out of range, the output Observable will emit an ArgumentOutOfRangeError error.

Parameters :
Name Type Optional Description
this typeReference
index number

Is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

defaultValue typeReference true

The default value returned for missing indices.

Example :

Emit only the third click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.elementAt(2); result.subscribe(x => console.log(x));

// Results in: // click 1 = nothing // click 2 = nothing // click 3 = MouseEvent object logged to console

node_modules__/zone.js/lib/browser/event-target.ts

eventTargetPatch
eventTargetPatch(_global: any, api: typeReference)
Parameters :
Name Type Optional Description
_global any
api typeReference
patchEvent
patchEvent(global: any, api: typeReference)
Parameters :
Name Type Optional Description
global any
api typeReference

node_modules_/zone.js/lib/browser/event-target.ts

eventTargetPatch
eventTargetPatch(_global: any, api: typeReference)
Parameters :
Name Type Optional Description
_global any
api typeReference
patchEvent
patchEvent(global: any, api: typeReference)
Parameters :
Name Type Optional Description
global any
api typeReference

node_modules_/rxjs/src/operators/every.ts

every
every(predicate: undefined, thisArg?: any)

Returns an Observable that emits whether or not every item of the source satisfies the condition specified.

Parameters :
Name Type Optional Description
predicate

A function for determining if an item meets a specified condition.

thisArg any true

Optional object to use for this in the callback.

Example :

A simple example emitting true if all elements are less than 5, false otherwise Observable.of(1, 2, 3, 4, 5, 6) .every(x => x < 5) .subscribe(x => console.log(x)); // -> false

node_modules__/rxjs/src/operators/every.ts

every
every(predicate: undefined, thisArg?: any)

Returns an Observable that emits whether or not every item of the source satisfies the condition specified.

Parameters :
Name Type Optional Description
predicate

A function for determining if an item meets a specified condition.

thisArg any true

Optional object to use for this in the callback.

Example :

A simple example emitting true if all elements are less than 5, false otherwise Observable.of(1, 2, 3, 4, 5, 6) .every(x => x < 5) .subscribe(x => console.log(x)); // -> false

node_modules__/rxjs/src/operator/every.ts

every
every(this: typeReference, predicate: undefined, thisArg?: any)

Returns an Observable that emits whether or not every item of the source satisfies the condition specified.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function for determining if an item meets a specified condition.

thisArg any true

Optional object to use for this in the callback.

Example :

A simple example emitting true if all elements are less than 5, false otherwise Observable.of(1, 2, 3, 4, 5, 6) .every(x => x < 5) .subscribe(x => console.log(x)); // -> false

node_modules_/rxjs/src/operator/every.ts

every
every(this: typeReference, predicate: undefined, thisArg?: any)

Returns an Observable that emits whether or not every item of the source satisfies the condition specified.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function for determining if an item meets a specified condition.

thisArg any true

Optional object to use for this in the callback.

Example :

A simple example emitting true if all elements are less than 5, false otherwise Observable.of(1, 2, 3, 4, 5, 6) .every(x => x < 5) .subscribe(x => console.log(x)); // -> false

node_modules__/rxjs/src/operators/exhaust.ts

exhaust
exhaust()

Converts a higher-order Observable into a first-order Observable by dropping inner Observables while the previous inner Observable has not yet completed.

Flattens an Observable-of-Observables by dropping the next inner Observables while the current inner is still executing.

exhaust subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable begins emitting the items emitted by that inner Observable. So far, it behaves like {@link mergeAll}. However, exhaust ignores every new inner Observable if the previous Observable has not yet completed. Once that one completes, it will accept and flatten the next inner Observable and repeat this process.

Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(5)); var result = higherOrder.exhaust(); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/exhaust.ts

exhaust
exhaust(this: typeReference)

Converts a higher-order Observable into a first-order Observable by dropping inner Observables while the previous inner Observable has not yet completed.

Flattens an Observable-of-Observables by dropping the next inner Observables while the current inner is still executing.

exhaust subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable begins emitting the items emitted by that inner Observable. So far, it behaves like {@link mergeAll}. However, exhaust ignores every new inner Observable if the previous Observable has not yet completed. Once that one completes, it will accept and flatten the next inner Observable and repeat this process.

Parameters :
Name Type Optional Description
this typeReference
Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(5)); var result = higherOrder.exhaust(); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/exhaust.ts

exhaust
exhaust(this: typeReference)

Converts a higher-order Observable into a first-order Observable by dropping inner Observables while the previous inner Observable has not yet completed.

Flattens an Observable-of-Observables by dropping the next inner Observables while the current inner is still executing.

exhaust subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable begins emitting the items emitted by that inner Observable. So far, it behaves like {@link mergeAll}. However, exhaust ignores every new inner Observable if the previous Observable has not yet completed. Once that one completes, it will accept and flatten the next inner Observable and repeat this process.

Parameters :
Name Type Optional Description
this typeReference
Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(5)); var result = higherOrder.exhaust(); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/exhaust.ts

exhaust
exhaust()

Converts a higher-order Observable into a first-order Observable by dropping inner Observables while the previous inner Observable has not yet completed.

Flattens an Observable-of-Observables by dropping the next inner Observables while the current inner is still executing.

exhaust subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable begins emitting the items emitted by that inner Observable. So far, it behaves like {@link mergeAll}. However, exhaust ignores every new inner Observable if the previous Observable has not yet completed. Once that one completes, it will accept and flatten the next inner Observable and repeat this process.

Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(5)); var result = higherOrder.exhaust(); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/exhaustMap.ts

exhaustMap
exhaustMap(project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable only if the previous projected Observable has completed.

Maps each value to an Observable, then flattens all of these inner Observables using {@link exhaust}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. When it projects a source value to an Observable, the output Observable begins emitting the items emitted by that projected Observable. However, exhaustMap ignores every new projected Observable if the previous projected Observable has not yet completed. Once that one completes, it will accept and flatten the next projected Observable and repeat this process.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.exhaustMap((ev) => Rx.Observable.interval(1000).take(5)); result.subscribe(x => console.log(x));

exhaustMap
exhaustMap(project: undefined)
Parameters :
Name Type Optional Description
project
exhaustMap
exhaustMap(project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
project
resultSelector

node_modules__/rxjs/src/operator/exhaustMap.ts

exhaustMap
exhaustMap(this: typeReference, project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector
exhaustMap
exhaustMap(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
exhaustMap
exhaustMap(this: typeReference, project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable only if the previous projected Observable has completed.

Maps each value to an Observable, then flattens all of these inner Observables using {@link exhaust}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. When it projects a source value to an Observable, the output Observable begins emitting the items emitted by that projected Observable. However, exhaustMap ignores every new projected Observable if the previous projected Observable has not yet completed. Once that one completes, it will accept and flatten the next projected Observable and repeat this process.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.exhaustMap((ev) => Rx.Observable.interval(1000).take(5)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/exhaustMap.ts

exhaustMap
exhaustMap(this: typeReference, project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector
exhaustMap
exhaustMap(this: typeReference, project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable only if the previous projected Observable has completed.

Maps each value to an Observable, then flattens all of these inner Observables using {@link exhaust}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. When it projects a source value to an Observable, the output Observable begins emitting the items emitted by that projected Observable. However, exhaustMap ignores every new projected Observable if the previous projected Observable has not yet completed. Once that one completes, it will accept and flatten the next projected Observable and repeat this process.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.exhaustMap((ev) => Rx.Observable.interval(1000).take(5)); result.subscribe(x => console.log(x));

exhaustMap
exhaustMap(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project

node_modules_/rxjs/src/operators/exhaustMap.ts

exhaustMap
exhaustMap(project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable only if the previous projected Observable has completed.

Maps each value to an Observable, then flattens all of these inner Observables using {@link exhaust}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. When it projects a source value to an Observable, the output Observable begins emitting the items emitted by that projected Observable. However, exhaustMap ignores every new projected Observable if the previous projected Observable has not yet completed. Once that one completes, it will accept and flatten the next projected Observable and repeat this process.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.exhaustMap((ev) => Rx.Observable.interval(1000).take(5)); result.subscribe(x => console.log(x));

exhaustMap
exhaustMap(project: undefined)
Parameters :
Name Type Optional Description
project
exhaustMap
exhaustMap(project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
project
resultSelector

node_modules__/rxjs/src/operator/expand.ts

expand
expand(this: typeReference, project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
project
concurrent number true
scheduler typeReference true
expand
expand(this: typeReference, project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
project
concurrent number true
scheduler typeReference true
expand
expand(this: typeReference, project: undefined, concurrent: number, scheduler: typeReference)

Recursively projects each source value to an Observable which is merged in the output Observable.

It's similar to {@link mergeMap}, but applies the projection function to every source value as well as every output value. It's recursive.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger. Expand will re-emit on the output Observable every source value. Then, each output value is given to the project function which returns an inner Observable to be merged on the output Observable. Those output values resulting from the projection are also given to the project function to produce new output values. This is how expand behaves recursively.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source or the output Observable, returns an Observable.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

scheduler typeReference

The IScheduler to use for subscribing to each projected inner Observable.

Example :

Start emitting the powers of two on every click, at most 10 of them var clicks = Rx.Observable.fromEvent(document, 'click'); var powersOfTwo = clicks .mapTo(1) .expand(x => Rx.Observable.of(2 * x).delay(1000)) .take(10); powersOfTwo.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/expand.ts

expand
expand(this: typeReference, project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
project
concurrent number true
scheduler typeReference true
expand
expand(this: typeReference, project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
project
concurrent number true
scheduler typeReference true
expand
expand(this: typeReference, project: undefined, concurrent: number, scheduler: typeReference)

Recursively projects each source value to an Observable which is merged in the output Observable.

It's similar to {@link mergeMap}, but applies the projection function to every source value as well as every output value. It's recursive.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger. Expand will re-emit on the output Observable every source value. Then, each output value is given to the project function which returns an inner Observable to be merged on the output Observable. Those output values resulting from the projection are also given to the project function to produce new output values. This is how expand behaves recursively.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source or the output Observable, returns an Observable.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

scheduler typeReference

The IScheduler to use for subscribing to each projected inner Observable.

Example :

Start emitting the powers of two on every click, at most 10 of them var clicks = Rx.Observable.fromEvent(document, 'click'); var powersOfTwo = clicks .mapTo(1) .expand(x => Rx.Observable.of(2 * x).delay(1000)) .take(10); powersOfTwo.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/expand.ts

expand
expand(project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
project
concurrent number true
scheduler typeReference true
expand
expand(project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
project
concurrent number true
scheduler typeReference true
expand
expand(project: undefined, concurrent: number, scheduler: typeReference)

Recursively projects each source value to an Observable which is merged in the output Observable.

It's similar to {@link mergeMap}, but applies the projection function to every source value as well as every output value. It's recursive.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger. Expand will re-emit on the output Observable every source value. Then, each output value is given to the project function which returns an inner Observable to be merged on the output Observable. Those output values resulting from the projection are also given to the project function to produce new output values. This is how expand behaves recursively.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source or the output Observable, returns an Observable.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

scheduler typeReference

The IScheduler to use for subscribing to each projected inner Observable.

Example :

Start emitting the powers of two on every click, at most 10 of them var clicks = Rx.Observable.fromEvent(document, 'click'); var powersOfTwo = clicks .mapTo(1) .expand(x => Rx.Observable.of(2 * x).delay(1000)) .take(10); powersOfTwo.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/expand.ts

expand
expand(project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
project
concurrent number true
scheduler typeReference true
expand
expand(project: undefined, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
project
concurrent number true
scheduler typeReference true
expand
expand(project: undefined, concurrent: number, scheduler: typeReference)

Recursively projects each source value to an Observable which is merged in the output Observable.

It's similar to {@link mergeMap}, but applies the projection function to every source value as well as every output value. It's recursive.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger. Expand will re-emit on the output Observable every source value. Then, each output value is given to the project function which returns an inner Observable to be merged on the output Observable. Those output values resulting from the projection are also given to the project function to produce new output values. This is how expand behaves recursively.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source or the output Observable, returns an Observable.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

scheduler typeReference

The IScheduler to use for subscribing to each projected inner Observable.

Example :

Start emitting the powers of two on every click, at most 10 of them var clicks = Rx.Observable.fromEvent(document, 'click'); var powersOfTwo = clicks .mapTo(1) .expand(x => Rx.Observable.of(2 * x).delay(1000)) .take(10); powersOfTwo.subscribe(x => console.log(x));

node_modules__/@compodoc/compodoc/src/utils/link-parser.ts

extractLeadingText
extractLeadingText(string: , completeTag: )
Parameters :
Name Type Optional Description
string
completeTag
splitLinkText
splitLinkText(text: )
Parameters :
Name Type Optional Description
text

node_modules_/@compodoc/compodoc/src/utils/link-parser.ts

extractLeadingText
extractLeadingText(string: , completeTag: )
Parameters :
Name Type Optional Description
string
completeTag
splitLinkText
splitLinkText(text: )
Parameters :
Name Type Optional Description
text

node_modules__/rxjs/src/operator/filter.ts

filter
filter(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true
filter
filter(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true
filter
filter(this: typeReference, predicate: undefined, thisArg?: any)

Filter items emitted by the source Observable by only emitting those that satisfy a specified predicate.

Like Array.prototype.filter(), it only emits a value from the source if it passes a criterion function.

Similar to the well-known Array.prototype.filter method, this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted, if false the value is not passed to the output Observable. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit only click events whose target was a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksOnDivs = clicks.filter(ev => ev.target.tagName === 'DIV'); clicksOnDivs.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/filter.ts

filter
filter(predicate: undefined, thisArg?: any)

Filter items emitted by the source Observable by only emitting those that satisfy a specified predicate.

Like Array.prototype.filter(), it only emits a value from the source if it passes a criterion function.

Similar to the well-known Array.prototype.filter method, this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

Parameters :
Name Type Optional Description
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted, if false the value is not passed to the output Observable. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit only click events whose target was a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksOnDivs = clicks.filter(ev => ev.target.tagName === 'DIV'); clicksOnDivs.subscribe(x => console.log(x));

filter
filter(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
filter
filter(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true

node_modules_/rxjs/src/operator/filter.ts

filter
filter(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true
filter
filter(this: typeReference, predicate: undefined, thisArg?: any)

Filter items emitted by the source Observable by only emitting those that satisfy a specified predicate.

Like Array.prototype.filter(), it only emits a value from the source if it passes a criterion function.

Similar to the well-known Array.prototype.filter method, this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted, if false the value is not passed to the output Observable. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit only click events whose target was a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksOnDivs = clicks.filter(ev => ev.target.tagName === 'DIV'); clicksOnDivs.subscribe(x => console.log(x));

filter
filter(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true

node_modules_/rxjs/src/operators/filter.ts

filter
filter(predicate: undefined, thisArg?: any)

Filter items emitted by the source Observable by only emitting those that satisfy a specified predicate.

Like Array.prototype.filter(), it only emits a value from the source if it passes a criterion function.

Similar to the well-known Array.prototype.filter method, this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

Parameters :
Name Type Optional Description
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted, if false the value is not passed to the output Observable. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit only click events whose target was a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksOnDivs = clicks.filter(ev => ev.target.tagName === 'DIV'); clicksOnDivs.subscribe(x => console.log(x));

filter
filter(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
filter
filter(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true

node_modules_/rxjs/src/operators/finalize.ts

finalize
finalize(callback: undefined)

Returns an Observable that mirrors the source Observable, but will call a specified function when the source terminates on complete or error.

Parameters :
Name Type Optional Description
callback

Function to be called when source terminates.

node_modules__/rxjs/src/operators/finalize.ts

finalize
finalize(callback: undefined)

Returns an Observable that mirrors the source Observable, but will call a specified function when the source terminates on complete or error.

Parameters :
Name Type Optional Description
callback

Function to be called when source terminates.

node_modules_/rxjs/src/operators/find.ts

find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
find
find(predicate: undefined, thisArg?: any)

Emits only the first value emitted by the source Observable that meets some condition.

Finds the first value that passes some test and emits that.

find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Unlike {@link first}, the predicate is required in find, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Find and emit the first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.find(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/find.ts

find
find(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true
find
find(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true
find
find(this: typeReference, predicate: undefined, thisArg?: any)

Emits only the first value emitted by the source Observable that meets some condition.

Finds the first value that passes some test and emits that.

find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Unlike {@link first}, the predicate is required in find, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Find and emit the first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.find(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/find.ts

find
find(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true
find
find(this: typeReference, predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
this typeReference
predicate
thisArg any true
find
find(this: typeReference, predicate: undefined, thisArg?: any)

Emits only the first value emitted by the source Observable that meets some condition.

Finds the first value that passes some test and emits that.

find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Unlike {@link first}, the predicate is required in find, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Find and emit the first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.find(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/find.ts

find
find(predicate: undefined, thisArg?: any)

Emits only the first value emitted by the source Observable that meets some condition.

Finds the first value that passes some test and emits that.

find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Unlike {@link first}, the predicate is required in find, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Find and emit the first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.find(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true
find
find(predicate: undefined, thisArg?: any)
Parameters :
Name Type Optional Description
predicate
thisArg any true

node_modules_/zone.js/lib/common/events.ts

findEventTasks
findEventTasks(target: any, eventName: string)
Parameters :
Name Type Optional Description
target any
eventName string
patchEventPrototype
patchEventPrototype(global: any, api: typeReference)
Parameters :
Name Type Optional Description
global any
api typeReference
patchEventTarget
patchEventTarget(_global: any, apis: undefined, patchOptions?: typeReference)
Parameters :
Name Type Optional Description
_global any
apis
patchOptions typeReference true

node_modules__/zone.js/lib/common/events.ts

findEventTasks
findEventTasks(target: any, eventName: string)
Parameters :
Name Type Optional Description
target any
eventName string
patchEventPrototype
patchEventPrototype(global: any, api: typeReference)
Parameters :
Name Type Optional Description
global any
api typeReference
patchEventTarget
patchEventTarget(_global: any, apis: undefined, patchOptions?: typeReference)
Parameters :
Name Type Optional Description
_global any
apis
patchOptions typeReference true

node_modules__/rxjs/src/operators/findIndex.ts

findIndex
findIndex(predicate: undefined, thisArg?: any)

Emits only the index of the first value emitted by the source Observable that meets some condition.

It's like {@link find}, but emits the index of the found value, not the value itself.

findIndex searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the (zero-based) index of the first occurrence in the source. Unlike {@link first}, the predicate is required in findIndex, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit the index of first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.findIndex(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/findIndex.ts

findIndex
findIndex(predicate: undefined, thisArg?: any)

Emits only the index of the first value emitted by the source Observable that meets some condition.

It's like {@link find}, but emits the index of the found value, not the value itself.

findIndex searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the (zero-based) index of the first occurrence in the source. Unlike {@link first}, the predicate is required in findIndex, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit the index of first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.findIndex(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/findIndex.ts

findIndex
findIndex(this: typeReference, predicate: undefined, thisArg?: any)

Emits only the index of the first value emitted by the source Observable that meets some condition.

It's like {@link find}, but emits the index of the found value, not the value itself.

findIndex searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the (zero-based) index of the first occurrence in the source. Unlike {@link first}, the predicate is required in findIndex, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit the index of first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.findIndex(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/findIndex.ts

findIndex
findIndex(this: typeReference, predicate: undefined, thisArg?: any)

Emits only the index of the first value emitted by the source Observable that meets some condition.

It's like {@link find}, but emits the index of the found value, not the value itself.

findIndex searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the (zero-based) index of the first occurrence in the source. Unlike {@link first}, the predicate is required in findIndex, and does not emit an error if a valid value is not found.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function called with each item to test for condition matching.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Emit the index of first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.findIndex(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/first.ts

first
first(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
first
first(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
first
first(this: typeReference, predicate?: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate true
first
first(this: typeReference, predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector true
defaultValue typeReference true
first
first(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
first
first(this: typeReference, predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Emits only the first value (or the first value that meets some condition) emitted by the source Observable.

Emits only the first value. Or emits only the first value that passes some test.

If called with no arguments, first emits the first value of the source Observable, then completes. If called with a predicate function, first emits the first value of the source that matches the specified condition. It may also take a resultSelector function to produce the output value from the input value, and a defaultValue to emit in case the source completes before it is able to emit a valid value. Throws an error if defaultValue was not provided and a matching element is not found.

Parameters :
Name Type Optional Description
this typeReference
predicate true

An optional function called with each item to test for condition matching.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source Observable. The arguments passed to this function are:

  • value: the value that was emitted on the source.
  • index: the "index" of the value from the source.
defaultValue typeReference true

The default value emitted in case no valid value was found on the source.

Example :

Emit only the first click that happens on the DOM var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(); result.subscribe(x => console.log(x));

Emits the first click that happens on a DIV var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

first
first(this: typeReference, predicate: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate

node_modules__/rxjs/src/operators/first.ts

first
first(predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector true
defaultValue typeReference true
first
first(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
first
first(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
first
first(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
first
first(predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Emits only the first value (or the first value that meets some condition) emitted by the source Observable.

Emits only the first value. Or emits only the first value that passes some test.

If called with no arguments, first emits the first value of the source Observable, then completes. If called with a predicate function, first emits the first value of the source that matches the specified condition. It may also take a resultSelector function to produce the output value from the input value, and a defaultValue to emit in case the source completes before it is able to emit a valid value. Throws an error if defaultValue was not provided and a matching element is not found.

Parameters :
Name Type Optional Description
predicate true

An optional function called with each item to test for condition matching.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source Observable. The arguments passed to this function are:

  • value: the value that was emitted on the source.
  • index: the "index" of the value from the source.
defaultValue typeReference true

The default value emitted in case no valid value was found on the source.

Example :

Emit only the first click that happens on the DOM var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(); result.subscribe(x => console.log(x));

Emits the first click that happens on a DIV var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

first
first(predicate: undefined)
Parameters :
Name Type Optional Description
predicate
first
first(predicate?: undefined)
Parameters :
Name Type Optional Description
predicate true

node_modules_/rxjs/src/operators/first.ts

first
first(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
first
first(predicate?: undefined)
Parameters :
Name Type Optional Description
predicate true
first
first(predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector true
defaultValue typeReference true
first
first(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
first
first(predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Emits only the first value (or the first value that meets some condition) emitted by the source Observable.

Emits only the first value. Or emits only the first value that passes some test.

If called with no arguments, first emits the first value of the source Observable, then completes. If called with a predicate function, first emits the first value of the source that matches the specified condition. It may also take a resultSelector function to produce the output value from the input value, and a defaultValue to emit in case the source completes before it is able to emit a valid value. Throws an error if defaultValue was not provided and a matching element is not found.

Parameters :
Name Type Optional Description
predicate true

An optional function called with each item to test for condition matching.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source Observable. The arguments passed to this function are:

  • value: the value that was emitted on the source.
  • index: the "index" of the value from the source.
defaultValue typeReference true

The default value emitted in case no valid value was found on the source.

Example :

Emit only the first click that happens on the DOM var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(); result.subscribe(x => console.log(x));

Emits the first click that happens on a DIV var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

first
first(predicate: undefined)
Parameters :
Name Type Optional Description
predicate
first
first(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true

node_modules__/rxjs/src/operator/first.ts

first
first(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
first
first(this: typeReference, predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Emits only the first value (or the first value that meets some condition) emitted by the source Observable.

Emits only the first value. Or emits only the first value that passes some test.

If called with no arguments, first emits the first value of the source Observable, then completes. If called with a predicate function, first emits the first value of the source that matches the specified condition. It may also take a resultSelector function to produce the output value from the input value, and a defaultValue to emit in case the source completes before it is able to emit a valid value. Throws an error if defaultValue was not provided and a matching element is not found.

Parameters :
Name Type Optional Description
this typeReference
predicate true

An optional function called with each item to test for condition matching.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source Observable. The arguments passed to this function are:

  • value: the value that was emitted on the source.
  • index: the "index" of the value from the source.
defaultValue typeReference true

The default value emitted in case no valid value was found on the source.

Example :

Emit only the first click that happens on the DOM var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(); result.subscribe(x => console.log(x));

Emits the first click that happens on a DIV var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

first
first(this: typeReference, predicate: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate
first
first(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
first
first(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
first
first(this: typeReference, predicate?: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate true
first
first(this: typeReference, predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector true
defaultValue typeReference true

node_modules__/rxjs/src/Subscription.ts

flattenUnsubscriptionErrors
flattenUnsubscriptionErrors(errors: undefined)
Parameters :
Name Type Optional Description
errors

node_modules_/rxjs/src/Subscription.ts

flattenUnsubscriptionErrors
flattenUnsubscriptionErrors(errors: undefined)
Parameters :
Name Type Optional Description
errors

node_modules__/code-block-writer/src/code-block-writer.ts

getIndentationText
getIndentationText(useTabs: boolean, numberSpaces: number)
Parameters :
Name Type Optional Description
useTabs boolean
numberSpaces number

node_modules_/code-block-writer/src/code-block-writer.ts

getIndentationText
getIndentationText(useTabs: boolean, numberSpaces: number)
Parameters :
Name Type Optional Description
useTabs boolean
numberSpaces number

node_modules__/rxjs/src/observable/IteratorObservable.ts

getIterator
getIterator(obj: any)
Parameters :
Name Type Optional Description
obj any
numberIsFinite
numberIsFinite(value: any)
Parameters :
Name Type Optional Description
value any
sign
sign(value: any)
Parameters :
Name Type Optional Description
value any
toLength
toLength(o: any)
Parameters :
Name Type Optional Description
o any

node_modules_/rxjs/src/observable/IteratorObservable.ts

getIterator
getIterator(obj: any)
Parameters :
Name Type Optional Description
obj any
numberIsFinite
numberIsFinite(value: any)
Parameters :
Name Type Optional Description
value any
sign
sign(value: any)
Parameters :
Name Type Optional Description
value any
toLength
toLength(o: any)
Parameters :
Name Type Optional Description
o any

node_modules__/rxjs/src/symbol/observable.ts

getSymbolObservable
getSymbolObservable(context: any)
Parameters :
Name Type Optional Description
context any

node_modules_/rxjs/src/symbol/observable.ts

getSymbolObservable
getSymbolObservable(context: any)
Parameters :
Name Type Optional Description
context any

node_modules_/rxjs/src/operators/groupBy.ts

groupBy
groupBy(keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)

Groups the items emitted by an Observable according to a specified criterion, and emits these grouped items as GroupedObservables, one GroupedObservable per group.

Parameters :
Name Type Optional Description
keySelector

A function that extracts the key for each item.

elementSelector true

A function that extracts the return element for each item.

durationSelector true

A function that returns an Observable to determine how long each group should exist.

subjectSelector true
Example :

Group objects by id and return as array Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs3'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], [])) .subscribe(p => console.log(p));

// displays: // [ { id: 1, name: 'aze1' }, // { id: 1, name: 'erg1' }, // { id: 1, name: 'df1' } ] // // [ { id: 2, name: 'sf2' }, // { id: 2, name: 'dg2' }, // { id: 2, name: 'sfqfb2' }, // { id: 2, name: 'qsgqsfg2' } ] // // [ { id: 3, name: 'qfs3' } ]

Pivot data on the id field Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs1'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id, p => p.name) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], ["" + group$.key])) .map(arr => ({'id': parseInt(arr[0]), 'values': arr.slice(1)})) .subscribe(p => console.log(p));

// displays: // { id: 1, values: [ 'aze1', 'erg1', 'df1' ] } // { id: 2, values: [ 'sf2', 'dg2', 'sfqfb2', 'qsgqsfg2' ] } // { id: 3, values: [ 'qfs1' ] }

groupBy
groupBy(keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined)
Parameters :
Name Type Optional Description
keySelector
elementSelector true
durationSelector true
groupBy
groupBy(keySelector: undefined, elementSelector: undefined, durationSelector: undefined)
Parameters :
Name Type Optional Description
keySelector
elementSelector
durationSelector
groupBy
groupBy(keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)
Parameters :
Name Type Optional Description
keySelector
elementSelector true
durationSelector true
subjectSelector true
groupBy
groupBy(keySelector: undefined)
Parameters :
Name Type Optional Description
keySelector

node_modules__/rxjs/src/operators/groupBy.ts

groupBy
groupBy(keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)
Parameters :
Name Type Optional Description
keySelector
elementSelector true
durationSelector true
subjectSelector true
groupBy
groupBy(keySelector: undefined)
Parameters :
Name Type Optional Description
keySelector
groupBy
groupBy(keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined)
Parameters :
Name Type Optional Description
keySelector
elementSelector true
durationSelector true
groupBy
groupBy(keySelector: undefined, elementSelector: undefined, durationSelector: undefined)
Parameters :
Name Type Optional Description
keySelector
elementSelector
durationSelector
groupBy
groupBy(keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)

Groups the items emitted by an Observable according to a specified criterion, and emits these grouped items as GroupedObservables, one GroupedObservable per group.

Parameters :
Name Type Optional Description
keySelector

A function that extracts the key for each item.

elementSelector true

A function that extracts the return element for each item.

durationSelector true

A function that returns an Observable to determine how long each group should exist.

subjectSelector true
Example :

Group objects by id and return as array Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs3'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], [])) .subscribe(p => console.log(p));

// displays: // [ { id: 1, name: 'aze1' }, // { id: 1, name: 'erg1' }, // { id: 1, name: 'df1' } ] // // [ { id: 2, name: 'sf2' }, // { id: 2, name: 'dg2' }, // { id: 2, name: 'sfqfb2' }, // { id: 2, name: 'qsgqsfg2' } ] // // [ { id: 3, name: 'qfs3' } ]

Pivot data on the id field Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs1'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id, p => p.name) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], ["" + group$.key])) .map(arr => ({'id': parseInt(arr[0]), 'values': arr.slice(1)})) .subscribe(p => console.log(p));

// displays: // { id: 1, values: [ 'aze1', 'erg1', 'df1' ] } // { id: 2, values: [ 'sf2', 'dg2', 'sfqfb2', 'qsgqsfg2' ] } // { id: 3, values: [ 'qfs1' ] }

node_modules_/rxjs/src/operator/groupBy.ts

groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector: undefined, durationSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector
elementSelector
durationSelector
groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector
elementSelector true
durationSelector true
groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector
elementSelector true
durationSelector true
subjectSelector true
groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)

Groups the items emitted by an Observable according to a specified criterion, and emits these grouped items as GroupedObservables, one GroupedObservable per group.

Parameters :
Name Type Optional Description
this typeReference
keySelector

A function that extracts the key for each item.

elementSelector true

A function that extracts the return element for each item.

durationSelector true

A function that returns an Observable to determine how long each group should exist.

subjectSelector true
Example :

Group objects by id and return as array Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs3'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], [])) .subscribe(p => console.log(p));

// displays: // [ { id: 1, name: 'aze1' }, // { id: 1, name: 'erg1' }, // { id: 1, name: 'df1' } ] // // [ { id: 2, name: 'sf2' }, // { id: 2, name: 'dg2' }, // { id: 2, name: 'sfqfb2' }, // { id: 2, name: 'qsgqsfg2' } ] // // [ { id: 3, name: 'qfs3' } ]

Pivot data on the id field Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs1'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id, p => p.name) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], ["" + group$.key])) .map(arr => ({'id': parseInt(arr[0]), 'values': arr.slice(1)})) .subscribe(p => console.log(p));

// displays: // { id: 1, values: [ 'aze1', 'erg1', 'df1' ] } // { id: 2, values: [ 'sf2', 'dg2', 'sfqfb2', 'qsgqsfg2' ] } // { id: 3, values: [ 'qfs1' ] }

groupBy
groupBy(this: typeReference, keySelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector

node_modules__/rxjs/src/operator/groupBy.ts

groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)

Groups the items emitted by an Observable according to a specified criterion, and emits these grouped items as GroupedObservables, one GroupedObservable per group.

Parameters :
Name Type Optional Description
this typeReference
keySelector

A function that extracts the key for each item.

elementSelector true

A function that extracts the return element for each item.

durationSelector true

A function that returns an Observable to determine how long each group should exist.

subjectSelector true
Example :

Group objects by id and return as array Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs3'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], [])) .subscribe(p => console.log(p));

// displays: // [ { id: 1, name: 'aze1' }, // { id: 1, name: 'erg1' }, // { id: 1, name: 'df1' } ] // // [ { id: 2, name: 'sf2' }, // { id: 2, name: 'dg2' }, // { id: 2, name: 'sfqfb2' }, // { id: 2, name: 'qsgqsfg2' } ] // // [ { id: 3, name: 'qfs3' } ]

Pivot data on the id field Observable.of({id: 1, name: 'aze1'}, {id: 2, name: 'sf2'}, {id: 2, name: 'dg2'}, {id: 1, name: 'erg1'}, {id: 1, name: 'df1'}, {id: 2, name: 'sfqfb2'}, {id: 3, name: 'qfs1'}, {id: 2, name: 'qsgqsfg2'} ) .groupBy(p => p.id, p => p.name) .flatMap( (group$) => group$.reduce((acc, cur) => [...acc, cur], ["" + group$.key])) .map(arr => ({'id': parseInt(arr[0]), 'values': arr.slice(1)})) .subscribe(p => console.log(p));

// displays: // { id: 1, values: [ 'aze1', 'erg1', 'df1' ] } // { id: 2, values: [ 'sf2', 'dg2', 'sfqfb2', 'qsgqsfg2' ] } // { id: 3, values: [ 'qfs1' ] }

groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined, subjectSelector?: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector
elementSelector true
durationSelector true
subjectSelector true
groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector?: undefined, durationSelector?: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector
elementSelector true
durationSelector true
groupBy
groupBy(this: typeReference, keySelector: undefined, elementSelector: undefined, durationSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector
elementSelector
durationSelector
groupBy
groupBy(this: typeReference, keySelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
keySelector

node_modules__/rxjs/src/util/identity.ts

identity
identity(x: typeReference)
Parameters :
Name Type Optional Description
x typeReference

node_modules_/rxjs/src/util/identity.ts

identity
identity(x: typeReference)
Parameters :
Name Type Optional Description
x typeReference

node_modules_/rxjs/src/operator/ignoreElements.ts

ignoreElements
ignoreElements(this: typeReference)

Ignores all items emitted by the source Observable and only passes calls of complete or error.

Parameters :
Name Type Optional Description
this typeReference

node_modules__/rxjs/src/operator/ignoreElements.ts

ignoreElements
ignoreElements(this: typeReference)

Ignores all items emitted by the source Observable and only passes calls of complete or error.

Parameters :
Name Type Optional Description
this typeReference

node_modules_/rxjs/src/operators/ignoreElements.ts

ignoreElements
ignoreElements()

node_modules__/rxjs/src/operators/ignoreElements.ts

ignoreElements
ignoreElements()

node_modules_/rxjs/src/util/isDate.ts

isDate
isDate(value: any)
Parameters :
Name Type Optional Description
value any

node_modules__/rxjs/src/util/isDate.ts

isDate
isDate(value: any)
Parameters :
Name Type Optional Description
value any

node_modules__/rxjs/src/operators/isEmpty.ts

isEmpty
isEmpty()

node_modules_/rxjs/src/operator/isEmpty.ts

isEmpty
isEmpty(this: typeReference)

If the source Observable is empty it returns an Observable that emits true, otherwise it emits false.

Parameters :
Name Type Optional Description
this typeReference

node_modules_/rxjs/src/operators/isEmpty.ts

isEmpty
isEmpty()

node_modules__/rxjs/src/operator/isEmpty.ts

isEmpty
isEmpty(this: typeReference)

If the source Observable is empty it returns an Observable that emits true, otherwise it emits false.

Parameters :
Name Type Optional Description
this typeReference

node_modules__/rxjs/src/observable/FromEventObservable.ts

isEventTarget
isEventTarget(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isHTMLCollection
isHTMLCollection(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isJQueryStyleEventEmitter
isJQueryStyleEventEmitter(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isNodeList
isNodeList(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isNodeStyleEventEmitter
isNodeStyleEventEmitter(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any

node_modules_/rxjs/src/observable/FromEventObservable.ts

isEventTarget
isEventTarget(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isHTMLCollection
isHTMLCollection(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isJQueryStyleEventEmitter
isJQueryStyleEventEmitter(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isNodeList
isNodeList(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any
isNodeStyleEventEmitter
isNodeStyleEventEmitter(sourceObj: any)
Parameters :
Name Type Optional Description
sourceObj any

node_modules__/rxjs/src/util/isFunction.ts

isFunction
isFunction(x: any)
Parameters :
Name Type Optional Description
x any

node_modules_/rxjs/src/util/isFunction.ts

isFunction
isFunction(x: any)
Parameters :
Name Type Optional Description
x any

node_modules__/@compodoc/compodoc/src/utils/global.path.ts

isGlobal
isGlobal()

node_modules_/@compodoc/compodoc/src/utils/global.path.ts

isGlobal
isGlobal()

node_modules_/rxjs/src/util/isNumeric.ts

isNumeric
isNumeric(val: any)
Parameters :
Name Type Optional Description
val any

node_modules__/rxjs/src/util/isNumeric.ts

isNumeric
isNumeric(val: any)
Parameters :
Name Type Optional Description
val any

node_modules__/rxjs/src/util/isObject.ts

isObject
isObject(x: any)
Parameters :
Name Type Optional Description
x any

node_modules_/rxjs/src/util/isObject.ts

isObject
isObject(x: any)
Parameters :
Name Type Optional Description
x any

node_modules_/rxjs/src/util/isPromise.ts

isPromise
isPromise(value: undefined)
Parameters :
Name Type Optional Description
value

node_modules__/rxjs/src/util/isPromise.ts

isPromise
isPromise(value: undefined)
Parameters :
Name Type Optional Description
value

node_modules_/rxjs/src/util/isScheduler.ts

isScheduler
isScheduler(value: any)
Parameters :
Name Type Optional Description
value any

node_modules__/rxjs/src/util/isScheduler.ts

isScheduler
isScheduler(value: any)
Parameters :
Name Type Optional Description
value any

node_modules__/@compodoc/compodoc/src/utils/kind-to-type.ts

kindToType
kindToType(kind: number)
Parameters :
Name Type Optional Description
kind number

node_modules_/@compodoc/compodoc/src/utils/kind-to-type.ts

kindToType
kindToType(kind: number)
Parameters :
Name Type Optional Description
kind number

node_modules__/rxjs/src/operator/last.ts

last
last(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
last
last(this: typeReference, predicate: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate
last
last(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
last
last(this: typeReference, predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Returns an Observable that emits only the last item emitted by the source Observable. It optionally takes a predicate function as a parameter, in which case, rather than emitting the last item from the source Observable, the resulting Observable will emit the last item from the source Observable that satisfies the predicate.

Parameters :
Name Type Optional Description
this typeReference
predicate true
  • The condition any source emitted item has to satisfy.
resultSelector true
defaultValue typeReference true
last
last(this: typeReference, predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector true
defaultValue typeReference true
last
last(this: typeReference, predicate?: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate true
last
last(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true

node_modules_/rxjs/src/operators/last.ts

last
last(predicate: undefined)
Parameters :
Name Type Optional Description
predicate
last
last(predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Returns an Observable that emits only the last item emitted by the source Observable. It optionally takes a predicate function as a parameter, in which case, rather than emitting the last item from the source Observable, the resulting Observable will emit the last item from the source Observable that satisfies the predicate.

Parameters :
Name Type Optional Description
predicate true
  • The condition any source emitted item has to satisfy.
resultSelector true
defaultValue typeReference true
last
last(predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector true
defaultValue typeReference true
last
last(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
last
last(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
last
last(predicate?: undefined)
Parameters :
Name Type Optional Description
predicate true
last
last(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true

node_modules__/rxjs/src/operators/last.ts

last
last(predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Returns an Observable that emits only the last item emitted by the source Observable. It optionally takes a predicate function as a parameter, in which case, rather than emitting the last item from the source Observable, the resulting Observable will emit the last item from the source Observable that satisfies the predicate.

Parameters :
Name Type Optional Description
predicate true
  • The condition any source emitted item has to satisfy.
resultSelector true
defaultValue typeReference true
last
last(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
last
last(predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector true
defaultValue typeReference true
last
last(predicate?: undefined)
Parameters :
Name Type Optional Description
predicate true
last
last(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
last
last(predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
predicate
resultSelector
defaultValue typeReference true
last
last(predicate: undefined)
Parameters :
Name Type Optional Description
predicate

node_modules_/rxjs/src/operator/last.ts

last
last(this: typeReference, predicate?: undefined, resultSelector?: undefined, defaultValue?: typeReference)

Returns an Observable that emits only the last item emitted by the source Observable. It optionally takes a predicate function as a parameter, in which case, rather than emitting the last item from the source Observable, the resulting Observable will emit the last item from the source Observable that satisfies the predicate.

Parameters :
Name Type Optional Description
this typeReference
predicate true
  • The condition any source emitted item has to satisfy.
resultSelector true
defaultValue typeReference true
last
last(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
last
last(this: typeReference, predicate: undefined, resultSelector?: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector true
defaultValue typeReference true
last
last(this: typeReference, predicate?: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate true
last
last(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
last
last(this: typeReference, predicate: undefined, resultSelector: undefined, defaultValue?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
predicate
resultSelector
defaultValue typeReference true
last
last(this: typeReference, predicate: undefined)
Parameters :
Name Type Optional Description
this typeReference
predicate

node_modules_/rxjs/src/operator/let.ts

letProto
letProto(this: typeReference, func: undefined)
Parameters :
Name Type Optional Description
this typeReference
func

node_modules__/rxjs/src/operator/let.ts

letProto
letProto(this: typeReference, func: undefined)
Parameters :
Name Type Optional Description
this typeReference
func

node_modules__/rxjs/src/operator/map.ts

map
map(this: typeReference, project: undefined, thisArg?: any)

Applies a given project function to each value emitted by the source Observable, and emits the resulting values as an Observable.

Like Array.prototype.map(), it passes each source value through a transformation function to get corresponding output values.

Similar to the well known Array.prototype.map function, this operator applies a projection to each value and emits that projection in the output Observable.

Parameters :
Name Type Optional Description
this typeReference
project

The function to apply to each value emitted by the source Observable. The index parameter is the number i for the i-th emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to define what this is in the project function.

Example :

Map every click to the clientX position of that click var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks.map(ev => ev.clientX); positions.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/map.ts

map
map(project: undefined, thisArg?: any)

Applies a given project function to each value emitted by the source Observable, and emits the resulting values as an Observable.

Like Array.prototype.map(), it passes each source value through a transformation function to get corresponding output values.

Similar to the well known Array.prototype.map function, this operator applies a projection to each value and emits that projection in the output Observable.

Parameters :
Name Type Optional Description
project

The function to apply to each value emitted by the source Observable. The index parameter is the number i for the i-th emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to define what this is in the project function.

Example :

Map every click to the clientX position of that click var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks.map(ev => ev.clientX); positions.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/map.ts

map
map(this: typeReference, project: undefined, thisArg?: any)

Applies a given project function to each value emitted by the source Observable, and emits the resulting values as an Observable.

Like Array.prototype.map(), it passes each source value through a transformation function to get corresponding output values.

Similar to the well known Array.prototype.map function, this operator applies a projection to each value and emits that projection in the output Observable.

Parameters :
Name Type Optional Description
this typeReference
project

The function to apply to each value emitted by the source Observable. The index parameter is the number i for the i-th emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to define what this is in the project function.

Example :

Map every click to the clientX position of that click var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks.map(ev => ev.clientX); positions.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/map.ts

map
map(project: undefined, thisArg?: any)

Applies a given project function to each value emitted by the source Observable, and emits the resulting values as an Observable.

Like Array.prototype.map(), it passes each source value through a transformation function to get corresponding output values.

Similar to the well known Array.prototype.map function, this operator applies a projection to each value and emits that projection in the output Observable.

Parameters :
Name Type Optional Description
project

The function to apply to each value emitted by the source Observable. The index parameter is the number i for the i-th emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to define what this is in the project function.

Example :

Map every click to the clientX position of that click var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks.map(ev => ev.clientX); positions.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/mapTo.ts

mapTo
mapTo(value: typeReference)

Emits the given constant value on the output Observable every time the source Observable emits a value.

Like {@link map}, but it maps every source value to the same output value every time.

Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

Parameters :
Name Type Optional Description
value typeReference

The value to map each source value to.

Example :

Map every click to the string 'Hi' var clicks = Rx.Observable.fromEvent(document, 'click'); var greetings = clicks.mapTo('Hi'); greetings.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/mapTo.ts

mapTo
mapTo(this: typeReference, value: typeReference)

Emits the given constant value on the output Observable every time the source Observable emits a value.

Like {@link map}, but it maps every source value to the same output value every time.

Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

Parameters :
Name Type Optional Description
this typeReference
value typeReference

The value to map each source value to.

Example :

Map every click to the string 'Hi' var clicks = Rx.Observable.fromEvent(document, 'click'); var greetings = clicks.mapTo('Hi'); greetings.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/mapTo.ts

mapTo
mapTo(value: typeReference)

Emits the given constant value on the output Observable every time the source Observable emits a value.

Like {@link map}, but it maps every source value to the same output value every time.

Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

Parameters :
Name Type Optional Description
value typeReference

The value to map each source value to.

Example :

Map every click to the string 'Hi' var clicks = Rx.Observable.fromEvent(document, 'click'); var greetings = clicks.mapTo('Hi'); greetings.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/mapTo.ts

mapTo
mapTo(this: typeReference, value: typeReference)

Emits the given constant value on the output Observable every time the source Observable emits a value.

Like {@link map}, but it maps every source value to the same output value every time.

Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

Parameters :
Name Type Optional Description
this typeReference
value typeReference

The value to map each source value to.

Example :

Map every click to the string 'Hi' var clicks = Rx.Observable.fromEvent(document, 'click'); var greetings = clicks.mapTo('Hi'); greetings.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/materialize.ts

materialize
materialize()

Represents all of the notifications from the source Observable as next emissions marked with their original types within Notification objects.

Wraps next, error and complete emissions in Notification objects, emitted as next on the output Observable.

materialize returns an Observable that emits a next notification for each next, error, or complete emission of the source Observable. When the source Observable emits complete, the output Observable will emit next as a Notification of type "complete", and then it will emit complete as well. When the source Observable emits error, the output will emit next as a Notification of type "error", and then complete.

This operator is useful for producing metadata of the source Observable, to be consumed as next emissions. Use it in conjunction with {@link dematerialize}.

Example :

Convert a faulty Observable to an Observable of Notifications var letters = Rx.Observable.of('a', 'b', 13, 'd'); var upperCase = letters.map(x => x.toUpperCase()); var materialized = upperCase.materialize(); materialized.subscribe(x => console.log(x));

// Results in the following: // - Notification {kind: "N", value: "A", error: undefined, hasValue: true} // - Notification {kind: "N", value: "B", error: undefined, hasValue: true} // - Notification {kind: "E", value: undefined, error: TypeError: // x.toUpperCase is not a function at MapSubscriber.letters.map.x // [as project] (http://1…, hasValue: false}

node_modules_/rxjs/src/operators/materialize.ts

materialize
materialize()

Represents all of the notifications from the source Observable as next emissions marked with their original types within Notification objects.

Wraps next, error and complete emissions in Notification objects, emitted as next on the output Observable.

materialize returns an Observable that emits a next notification for each next, error, or complete emission of the source Observable. When the source Observable emits complete, the output Observable will emit next as a Notification of type "complete", and then it will emit complete as well. When the source Observable emits error, the output will emit next as a Notification of type "error", and then complete.

This operator is useful for producing metadata of the source Observable, to be consumed as next emissions. Use it in conjunction with {@link dematerialize}.

Example :

Convert a faulty Observable to an Observable of Notifications var letters = Rx.Observable.of('a', 'b', 13, 'd'); var upperCase = letters.map(x => x.toUpperCase()); var materialized = upperCase.materialize(); materialized.subscribe(x => console.log(x));

// Results in the following: // - Notification {kind: "N", value: "A", error: undefined, hasValue: true} // - Notification {kind: "N", value: "B", error: undefined, hasValue: true} // - Notification {kind: "E", value: undefined, error: TypeError: // x.toUpperCase is not a function at MapSubscriber.letters.map.x // [as project] (http://1…, hasValue: false}

node_modules__/rxjs/src/operator/materialize.ts

materialize
materialize(this: typeReference)

Represents all of the notifications from the source Observable as next emissions marked with their original types within Notification objects.

Wraps next, error and complete emissions in Notification objects, emitted as next on the output Observable.

materialize returns an Observable that emits a next notification for each next, error, or complete emission of the source Observable. When the source Observable emits complete, the output Observable will emit next as a Notification of type "complete", and then it will emit complete as well. When the source Observable emits error, the output will emit next as a Notification of type "error", and then complete.

This operator is useful for producing metadata of the source Observable, to be consumed as next emissions. Use it in conjunction with {@link dematerialize}.

Parameters :
Name Type Optional Description
this typeReference
Example :

Convert a faulty Observable to an Observable of Notifications var letters = Rx.Observable.of('a', 'b', 13, 'd'); var upperCase = letters.map(x => x.toUpperCase()); var materialized = upperCase.materialize(); materialized.subscribe(x => console.log(x));

// Results in the following: // - Notification {kind: "N", value: "A", error: undefined, hasValue: true} // - Notification {kind: "N", value: "B", error: undefined, hasValue: true} // - Notification {kind: "E", value: undefined, error: TypeError: // x.toUpperCase is not a function at MapSubscriber.letters.map.x // [as project] (http://1…, hasValue: false}

node_modules_/rxjs/src/operator/materialize.ts

materialize
materialize(this: typeReference)

Represents all of the notifications from the source Observable as next emissions marked with their original types within Notification objects.

Wraps next, error and complete emissions in Notification objects, emitted as next on the output Observable.

materialize returns an Observable that emits a next notification for each next, error, or complete emission of the source Observable. When the source Observable emits complete, the output Observable will emit next as a Notification of type "complete", and then it will emit complete as well. When the source Observable emits error, the output will emit next as a Notification of type "error", and then complete.

This operator is useful for producing metadata of the source Observable, to be consumed as next emissions. Use it in conjunction with {@link dematerialize}.

Parameters :
Name Type Optional Description
this typeReference
Example :

Convert a faulty Observable to an Observable of Notifications var letters = Rx.Observable.of('a', 'b', 13, 'd'); var upperCase = letters.map(x => x.toUpperCase()); var materialized = upperCase.materialize(); materialized.subscribe(x => console.log(x));

// Results in the following: // - Notification {kind: "N", value: "A", error: undefined, hasValue: true} // - Notification {kind: "N", value: "B", error: undefined, hasValue: true} // - Notification {kind: "E", value: undefined, error: TypeError: // x.toUpperCase is not a function at MapSubscriber.letters.map.x // [as project] (http://1…, hasValue: false}

node_modules__/rxjs/src/operators/max.ts

max
max(comparer?: undefined)

The Max operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the largest value.

Parameters :
Name Type Optional Description
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the maximal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .max() .subscribe(x => console.log(x)); // -> 8

Use a comparer function to get the maximal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .max((a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Beer' }

node_modules_/rxjs/src/operator/max.ts

max
max(this: typeReference, comparer?: undefined)

The Max operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the largest value.

Parameters :
Name Type Optional Description
this typeReference
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the maximal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .max() .subscribe(x => console.log(x)); // -> 8

Use a comparer function to get the maximal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .max((a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Beer' }

node_modules_/rxjs/src/operators/max.ts

max
max(comparer?: undefined)

The Max operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the largest value.

Parameters :
Name Type Optional Description
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the maximal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .max() .subscribe(x => console.log(x)); // -> 8

Use a comparer function to get the maximal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .max((a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Beer' }

node_modules__/rxjs/src/operator/max.ts

max
max(this: typeReference, comparer?: undefined)

The Max operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the largest value.

Parameters :
Name Type Optional Description
this typeReference
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the maximal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .max() .subscribe(x => console.log(x)); // -> 8

Use a comparer function to get the maximal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .max((a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Beer' }

node_modules__/rxjs/src/observable/merge.ts

merge
merge(observables: typeReference)

Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
observables typeReference

Input Observables to merge together.

Example :

Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = Rx.Observable.merge(clicks, timer); clicksOrTimer.subscribe(x => console.log(x));

// Results in the following: // timer will emit ascending values, one every second(1000ms) to console // clicks logs MouseEvents to console everytime the "document" is clicked // Since the two streams are merged you see these happening // as they occur.

Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = Rx.Observable.merge(timer1, timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

// Results in the following: // - First timer1 and timer2 will run concurrently // - timer1 will emit a value every 1000ms for 10 iterations // - timer2 will emit a value every 2000ms for 6 iterations // - after timer1 hits it's max iteration, timer2 will // continue, and timer3 will start to run concurrently with timer2 // - when timer2 hits it's max iteration it terminates, and // timer3 will continue to emit a value every 500ms until it is complete

merge
merge(...observables: undefined)
Parameters :
Name Type Optional Description
observables
merge
merge(...observables: undefined)
Parameters :
Name Type Optional Description
observables
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true

node_modules__/rxjs/src/operators/merge.ts

merge
merge(concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
concurrent number true
scheduler typeReference true
merge
merge(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
merge
merge(scheduler?: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference true
merge
merge(v2: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
concurrent number true
scheduler typeReference true
merge
merge(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
scheduler typeReference true
merge
merge(observables: typeReference)

Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (either the source or an Observable given as argument), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = clicks.merge(timer); clicksOrTimer.subscribe(x => console.log(x));

Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = timer1.merge(timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

node_modules_/rxjs/src/observable/merge.ts

merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
concurrent number true
scheduler typeReference true
merge
merge(...observables: undefined)
Parameters :
Name Type Optional Description
observables
merge
merge(...observables: undefined)
Parameters :
Name Type Optional Description
observables
merge
merge(observables: typeReference)

Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
observables typeReference

Input Observables to merge together.

Example :

Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = Rx.Observable.merge(clicks, timer); clicksOrTimer.subscribe(x => console.log(x));

// Results in the following: // timer will emit ascending values, one every second(1000ms) to console // clicks logs MouseEvents to console everytime the "document" is clicked // Since the two streams are merged you see these happening // as they occur.

Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = Rx.Observable.merge(timer1, timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

// Results in the following: // - First timer1 and timer2 will run concurrently // - timer1 will emit a value every 1000ms for 10 iterations // - timer2 will emit a value every 2000ms for 6 iterations // - after timer1 hits it's max iteration, timer2 will // continue, and timer3 will start to run concurrently with timer2 // - when timer2 hits it's max iteration it terminates, and // timer3 will continue to emit a value every 500ms until it is complete

merge
merge(v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true

node_modules__/rxjs/src/operator/merge.ts

merge
merge(this: typeReference, observables: typeReference)

Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (either the source or an Observable given as argument), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference
Example :

Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = clicks.merge(timer); clicksOrTimer.subscribe(x => console.log(x));

Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = timer1.merge(timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

merge
merge(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
merge
merge(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
scheduler typeReference true
merge
merge(this: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference true

node_modules_/rxjs/src/operators/merge.ts

merge
merge(observables: typeReference)

Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (either the source or an Observable given as argument), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
observables typeReference
Example :

Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = clicks.merge(timer); clicksOrTimer.subscribe(x => console.log(x));

Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = timer1.merge(timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

merge
merge(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
merge
merge(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
scheduler typeReference true
merge
merge(v2: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
concurrent number true
scheduler typeReference true
merge
merge(v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
scheduler typeReference true
merge
merge(concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
concurrent number true
scheduler typeReference true
merge
merge(scheduler?: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference true

node_modules_/rxjs/src/operator/merge.ts

merge
merge(this: typeReference, observables: typeReference)

Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (either the source or an Observable given as argument), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference
Example :

Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = clicks.merge(timer); clicksOrTimer.subscribe(x => console.log(x));

Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = timer1.merge(timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

merge
merge(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
merge
merge(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
scheduler typeReference true
merge
merge(this: typeReference, concurrent?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
concurrent number true
scheduler typeReference true
merge
merge(this: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference true

node_modules__/rxjs/src/operator/mergeAll.ts

mergeAll
mergeAll(this: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
concurrent number true
mergeAll
mergeAll(this: typeReference, concurrent: number)

Converts a higher-order Observable into a first-order Observable which concurrently delivers all values that are emitted on the inner Observables.

Flattens an Observable-of-Observables.

mergeAll subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, it subscribes to that and delivers all the values from the inner Observable on the output Observable. The output Observable only completes once all inner Observables have completed. Any error delivered by a inner Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
this typeReference
concurrent number

Maximum number of inner Observables being subscribed to concurrently.

Example :

Spawn a new interval Observable for each click event, and blend their outputs as one Observable var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var firstOrder = higherOrder.mergeAll(); firstOrder.subscribe(x => console.log(x));

Count from 0 to 9 every second for each click, but only allow 2 concurrent timers var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(10)); var firstOrder = higherOrder.mergeAll(2); firstOrder.subscribe(x => console.log(x));

mergeAll
mergeAll(this: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
concurrent number true

node_modules_/rxjs/src/operator/mergeAll.ts

mergeAll
mergeAll(this: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
concurrent number true
mergeAll
mergeAll(this: typeReference, concurrent: number)

Converts a higher-order Observable into a first-order Observable which concurrently delivers all values that are emitted on the inner Observables.

Flattens an Observable-of-Observables.

mergeAll subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, it subscribes to that and delivers all the values from the inner Observable on the output Observable. The output Observable only completes once all inner Observables have completed. Any error delivered by a inner Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
this typeReference
concurrent number

Maximum number of inner Observables being subscribed to concurrently.

Example :

Spawn a new interval Observable for each click event, and blend their outputs as one Observable var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var firstOrder = higherOrder.mergeAll(); firstOrder.subscribe(x => console.log(x));

Count from 0 to 9 every second for each click, but only allow 2 concurrent timers var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(10)); var firstOrder = higherOrder.mergeAll(2); firstOrder.subscribe(x => console.log(x));

mergeAll
mergeAll(this: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
concurrent number true

node_modules__/rxjs/src/operators/mergeAll.ts

mergeAll
mergeAll(concurrent: number)

Converts a higher-order Observable into a first-order Observable which concurrently delivers all values that are emitted on the inner Observables.

Flattens an Observable-of-Observables.

mergeAll subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, it subscribes to that and delivers all the values from the inner Observable on the output Observable. The output Observable only completes once all inner Observables have completed. Any error delivered by a inner Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
concurrent number

Maximum number of inner Observables being subscribed to concurrently.

Example :

Spawn a new interval Observable for each click event, and blend their outputs as one Observable var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var firstOrder = higherOrder.mergeAll(); firstOrder.subscribe(x => console.log(x));

Count from 0 to 9 every second for each click, but only allow 2 concurrent timers var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(10)); var firstOrder = higherOrder.mergeAll(2); firstOrder.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/mergeAll.ts

mergeAll
mergeAll(concurrent: number)

Converts a higher-order Observable into a first-order Observable which concurrently delivers all values that are emitted on the inner Observables.

Flattens an Observable-of-Observables.

mergeAll subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, it subscribes to that and delivers all the values from the inner Observable on the output Observable. The output Observable only completes once all inner Observables have completed. Any error delivered by a inner Observable will be immediately emitted on the output Observable.

Parameters :
Name Type Optional Description
concurrent number

Maximum number of inner Observables being subscribed to concurrently.

Example :

Spawn a new interval Observable for each click event, and blend their outputs as one Observable var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var firstOrder = higherOrder.mergeAll(); firstOrder.subscribe(x => console.log(x));

Count from 0 to 9 every second for each click, but only allow 2 concurrent timers var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(10)); var firstOrder = higherOrder.mergeAll(2); firstOrder.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/mergeMap.ts

mergeMap
mergeMap(project: undefined, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
project
resultSelector
concurrent number true
mergeMap
mergeMap(project: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
project
concurrent number true
mergeMap
mergeMap(project: undefined, resultSelector?: undefined, concurrent: number)

Projects each source value to an Observable which is merged in the output Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link mergeAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Map and flatten each letter to an Observable ticking every 1 second var letters = Rx.Observable.of('a', 'b', 'c'); var result = letters.mergeMap(x => Rx.Observable.interval(1000).map(i => x+i) ); result.subscribe(x => console.log(x));

// Results in the following: // a0 // b0 // c0 // a1 // b1 // c1 // continues to list a,b,c with respective ascending integers

node_modules__/rxjs/src/operator/mergeMap.ts

mergeMap
mergeMap(this: typeReference, project: undefined, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector
concurrent number true
mergeMap
mergeMap(this: typeReference, project: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
project
concurrent number true
mergeMap
mergeMap(this: typeReference, project: undefined, resultSelector?: undefined, concurrent: number)

Projects each source value to an Observable which is merged in the output Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link mergeAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Map and flatten each letter to an Observable ticking every 1 second var letters = Rx.Observable.of('a', 'b', 'c'); var result = letters.mergeMap(x => Rx.Observable.interval(1000).map(i => x+i) ); result.subscribe(x => console.log(x));

// Results in the following: // a0 // b0 // c0 // a1 // b1 // c1 // continues to list a,b,c with respective ascending integers

node_modules_/rxjs/src/operators/mergeMap.ts

mergeMap
mergeMap(project: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
project
concurrent number true
mergeMap
mergeMap(project: undefined, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
project
resultSelector
concurrent number true
mergeMap
mergeMap(project: undefined, resultSelector?: undefined, concurrent: number)

Projects each source value to an Observable which is merged in the output Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link mergeAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Map and flatten each letter to an Observable ticking every 1 second var letters = Rx.Observable.of('a', 'b', 'c'); var result = letters.mergeMap(x => Rx.Observable.interval(1000).map(i => x+i) ); result.subscribe(x => console.log(x));

// Results in the following: // a0 // b0 // c0 // a1 // b1 // c1 // continues to list a,b,c with respective ascending integers

node_modules_/rxjs/src/operator/mergeMap.ts

mergeMap
mergeMap(this: typeReference, project: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
project
concurrent number true
mergeMap
mergeMap(this: typeReference, project: undefined, resultSelector?: undefined, concurrent: number)

Projects each source value to an Observable which is merged in the output Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link mergeAll}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Map and flatten each letter to an Observable ticking every 1 second var letters = Rx.Observable.of('a', 'b', 'c'); var result = letters.mergeMap(x => Rx.Observable.interval(1000).map(i => x+i) ); result.subscribe(x => console.log(x));

// Results in the following: // a0 // b0 // c0 // a1 // b1 // c1 // continues to list a,b,c with respective ascending integers

mergeMap
mergeMap(this: typeReference, project: undefined, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector
concurrent number true

node_modules_/rxjs/src/operator/mergeMapTo.ts

mergeMapTo
mergeMapTo(this: typeReference, observable: typeReference, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
resultSelector
concurrent number true
mergeMapTo
mergeMapTo(this: typeReference, observable: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
concurrent number true
mergeMapTo
mergeMapTo(this: typeReference, innerObservable: typeReference, resultSelector?: undefined, concurrent: number)

Projects each source value to the same Observable which is merged multiple times in the output Observable.

It's like {@link mergeMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then merges those resulting Observables into one single Observable, which is the output Observable.

Parameters :
Name Type Optional Description
this typeReference
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

For each click event, start an interval Observable ticking every 1 second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.mergeMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/mergeMapTo.ts

mergeMapTo
mergeMapTo(observable: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
observable typeReference
concurrent number true
mergeMapTo
mergeMapTo(observable: typeReference, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
observable typeReference
resultSelector
concurrent number true
mergeMapTo
mergeMapTo(innerObservable: typeReference, resultSelector?: undefined, concurrent: number)

Projects each source value to the same Observable which is merged multiple times in the output Observable.

It's like {@link mergeMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then merges those resulting Observables into one single Observable, which is the output Observable.

Parameters :
Name Type Optional Description
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

For each click event, start an interval Observable ticking every 1 second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.mergeMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/mergeMapTo.ts

mergeMapTo
mergeMapTo(observable: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
observable typeReference
concurrent number true
mergeMapTo
mergeMapTo(observable: typeReference, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
observable typeReference
resultSelector
concurrent number true
mergeMapTo
mergeMapTo(innerObservable: typeReference, resultSelector?: undefined, concurrent: number)

Projects each source value to the same Observable which is merged multiple times in the output Observable.

It's like {@link mergeMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then merges those resulting Observables into one single Observable, which is the output Observable.

Parameters :
Name Type Optional Description
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

For each click event, start an interval Observable ticking every 1 second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.mergeMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/mergeMapTo.ts

mergeMapTo
mergeMapTo(this: typeReference, observable: typeReference, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
concurrent number true
mergeMapTo
mergeMapTo(this: typeReference, observable: typeReference, resultSelector: undefined, concurrent?: number)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
resultSelector
concurrent number true
mergeMapTo
mergeMapTo(this: typeReference, innerObservable: typeReference, resultSelector?: undefined, concurrent: number)

Projects each source value to the same Observable which is merged multiple times in the output Observable.

It's like {@link mergeMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then merges those resulting Observables into one single Observable, which is the output Observable.

Parameters :
Name Type Optional Description
this typeReference
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

For each click event, start an interval Observable ticking every 1 second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.mergeMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/mergeScan.ts

mergeScan
mergeScan(accumulator: undefined, seed: typeReference, concurrent: number)

Applies an accumulator function over the source Observable where the accumulator function itself returns an Observable, then each intermediate Observable returned is merged into the output Observable.

It's like {@link scan}, but the Observables returned by the accumulator are merged into the outer Observable.

Parameters :
Name Type Optional Description
accumulator

The accumulator function called on each source value.

seed typeReference

The initial accumulation value.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Count the number of click events const click$ = Rx.Observable.fromEvent(document, 'click'); const one$ = click$.mapTo(1); const seed = 0; const count$ = one$.mergeScan((acc, one) => Rx.Observable.of(acc + one), seed); count$.subscribe(x => console.log(x));

// Results: 1 2 3 4 // ...and so on for each click

node_modules__/rxjs/src/operators/mergeScan.ts

mergeScan
mergeScan(accumulator: undefined, seed: typeReference, concurrent: number)

Applies an accumulator function over the source Observable where the accumulator function itself returns an Observable, then each intermediate Observable returned is merged into the output Observable.

It's like {@link scan}, but the Observables returned by the accumulator are merged into the outer Observable.

Parameters :
Name Type Optional Description
accumulator

The accumulator function called on each source value.

seed typeReference

The initial accumulation value.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Count the number of click events const click$ = Rx.Observable.fromEvent(document, 'click'); const one$ = click$.mapTo(1); const seed = 0; const count$ = one$.mergeScan((acc, one) => Rx.Observable.of(acc + one), seed); count$.subscribe(x => console.log(x));

// Results: 1 2 3 4 // ...and so on for each click

node_modules__/rxjs/src/operator/mergeScan.ts

mergeScan
mergeScan(this: typeReference, accumulator: undefined, seed: typeReference, concurrent: number)

Applies an accumulator function over the source Observable where the accumulator function itself returns an Observable, then each intermediate Observable returned is merged into the output Observable.

It's like {@link scan}, but the Observables returned by the accumulator are merged into the outer Observable.

Parameters :
Name Type Optional Description
this typeReference
accumulator

The accumulator function called on each source value.

seed typeReference

The initial accumulation value.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Count the number of click events const click$ = Rx.Observable.fromEvent(document, 'click'); const one$ = click$.mapTo(1); const seed = 0; const count$ = one$.mergeScan((acc, one) => Rx.Observable.of(acc + one), seed); count$.subscribe(x => console.log(x));

// Results: 1 2 3 4 // ...and so on for each click

node_modules_/rxjs/src/operator/mergeScan.ts

mergeScan
mergeScan(this: typeReference, accumulator: undefined, seed: typeReference, concurrent: number)

Applies an accumulator function over the source Observable where the accumulator function itself returns an Observable, then each intermediate Observable returned is merged into the output Observable.

It's like {@link scan}, but the Observables returned by the accumulator are merged into the outer Observable.

Parameters :
Name Type Optional Description
this typeReference
accumulator

The accumulator function called on each source value.

seed typeReference

The initial accumulation value.

concurrent number

Maximum number of input Observables being subscribed to concurrently.

Example :

Count the number of click events const click$ = Rx.Observable.fromEvent(document, 'click'); const one$ = click$.mapTo(1); const seed = 0; const count$ = one$.mergeScan((acc, one) => Rx.Observable.of(acc + one), seed); count$.subscribe(x => console.log(x));

// Results: 1 2 3 4 // ...and so on for each click

node_modules_/rxjs/src/operators/min.ts

min
min(comparer?: undefined)

The Min operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the smallest value.

Parameters :
Name Type Optional Description
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the minimal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .min() .subscribe(x => console.log(x)); // -> 2

Use a comparer function to get the minimal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .min( (a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Bar' }

node_modules__/rxjs/src/operators/min.ts

min
min(comparer?: undefined)

The Min operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the smallest value.

Parameters :
Name Type Optional Description
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the minimal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .min() .subscribe(x => console.log(x)); // -> 2

Use a comparer function to get the minimal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .min( (a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Bar' }

node_modules_/rxjs/src/operator/min.ts

min
min(this: typeReference, comparer?: undefined)

The Min operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the smallest value.

Parameters :
Name Type Optional Description
this typeReference
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the minimal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .min() .subscribe(x => console.log(x)); // -> 2

Use a comparer function to get the minimal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .min( (a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Bar' }

node_modules__/rxjs/src/operator/min.ts

min
min(this: typeReference, comparer?: undefined)

The Min operator operates on an Observable that emits numbers (or items that can be compared with a provided function), and when source Observable completes it emits a single item: the item with the smallest value.

Parameters :
Name Type Optional Description
this typeReference
comparer true
  • Optional comparer function that it will use instead of its default to compare the value of two items.
Example :

Get the minimal value of a series of numbers Rx.Observable.of(5, 4, 7, 2, 8) .min() .subscribe(x => console.log(x)); // -> 2

Use a comparer function to get the minimal item interface Person { age: number, name: string } Observable.of({age: 7, name: 'Foo'}, {age: 5, name: 'Bar'}, {age: 9, name: 'Beer'}) .min( (a: Person, b: Person) => a.age < b.age ? -1 : 1) .subscribe((x: Person) => console.log(x.name)); // -> 'Bar' }

node_modules__/rxjs/src/util/Set.ts

minimalSetImpl
minimalSetImpl()

node_modules_/rxjs/src/util/Set.ts

minimalSetImpl
minimalSetImpl()

node_modules_/rxjs/src/operators/multicast.ts

multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true
multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true
multicast
multicast(subjectOrSubjectFactory: undefined, selector?: undefined)

Returns an Observable that emits the results of invoking a specified selector on items emitted by a ConnectableObservable that shares a single subscription to the underlying stream.

Parameters :
Name Type Optional Description
subjectOrSubjectFactory
  • Factory function to create an intermediate subject through which the source sequence's elements will be multicast to the selector function or Subject to push source elements into.
selector true
  • Optional selector function that can use the multicasted source stream as many times as needed, without causing multiple subscriptions to the source stream. Subscribers to the given source will receive all notifications of the source from the time of the subscription forward.
multicast
multicast(subjectOrSubjectFactory: typeReference)
Parameters :
Name Type Optional Description
subjectOrSubjectFactory typeReference

node_modules__/rxjs/src/operators/multicast.ts

multicast
multicast(subjectOrSubjectFactory: typeReference)
Parameters :
Name Type Optional Description
subjectOrSubjectFactory typeReference
multicast
multicast(subjectOrSubjectFactory: undefined, selector?: undefined)

Returns an Observable that emits the results of invoking a specified selector on items emitted by a ConnectableObservable that shares a single subscription to the underlying stream.

Parameters :
Name Type Optional Description
subjectOrSubjectFactory
  • Factory function to create an intermediate subject through which the source sequence's elements will be multicast to the selector function or Subject to push source elements into.
selector true
  • Optional selector function that can use the multicasted source stream as many times as needed, without causing multiple subscriptions to the source stream. Subscribers to the given source will receive all notifications of the source from the time of the subscription forward.
multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true
multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true

node_modules_/rxjs/src/operator/multicast.ts

multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true
multicast
multicast(this: typeReference, subjectOrSubjectFactory: undefined, selector?: undefined)

Allows source Observable to be subscribed only once with a Subject of choice, while still sharing its values between multiple subscribers.

Subscribe to Observable once, but send its values to multiple subscribers.

multicast is an operator that works in two modes.

In the first mode you provide a single argument to it, which can be either an initialized Subject or a Subject factory. As a result you will get a special kind of an Observable - a ConnectableObservable. It can be subscribed multiple times, just as regular Observable, but it won't subscribe to the source Observable at that moment. It will do it only if you call its connect method. This means you can essentially control by hand, when source Observable will be actually subscribed. What is more, ConnectableObservable will share this one subscription between all of its subscribers. This means that, for example, ajax Observable will only send a request once, even though usually it would send a request per every subscriber. Since it sends a request at the moment of subscription, here request would be sent when the connect method of a ConnectableObservable is called.

The most common pattern of using ConnectableObservable is calling connect when the first consumer subscribes, keeping the subscription alive while several consumers come and go and finally unsubscribing from the source Observable, when the last consumer unsubscribes. To not implement that logic over and over again, ConnectableObservable has a special operator, refCount. When called, it returns an Observable, which will count the number of consumers subscribed to it and keep ConnectableObservable connected as long as there is at least one consumer. So if you don't actually need to decide yourself when to connect and disconnect a ConnectableObservable, use refCount.

The second mode is invoked by calling multicast with an additional, second argument - selector function. This function accepts an Observable - which basically mirrors the source Observable - and returns Observable as well, which should be the input stream modified by any operators you want. Note that in this mode you cannot provide initialized Subject as a first argument - it has to be a Subject factory. If you provide selector function, multicast returns just a regular Observable, instead of ConnectableObservable. Thus, as usual, each subscription to this stream triggers subscription to the source Observable. However, if inside the selector function you subscribe to the input Observable multiple times, actual source stream will be subscribed only once. So if you have a chain of operators that use some Observable many times, but you want to subscribe to that Observable only once, this is the mode you would use.

Subject provided as a first parameter of multicast is used as a proxy for the single subscription to the source Observable. It means that all values from the source stream go through that Subject. Thus, if a Subject has some special properties, Observable returned by multicast will have them as well. If you want to use multicast with a Subject that is one of the ones included in RxJS by default - Subject, AsyncSubject, BehaviorSubject, or ReplaySubject - simply use {@link publish}, {@link publishLast}, {@link publishBehavior} or {@link publishReplay} respectively. These are actually just wrappers around multicast, with a specific Subject hardcoded inside.

Also, if you use {@link publish} or {@link publishReplay} with a ConnectableObservables refCount operator, you can simply use {@link share} and {@link shareReplay} respectively, which chain these two.

Parameters :
Name Type Optional Description
this typeReference
subjectOrSubjectFactory
  • Factory function to create an intermediate Subject through which the source sequence's elements will be multicast to the selector function input Observable or ConnectableObservable returned by the operator.
selector true
  • Optional selector function that can use the input stream as many times as needed, without causing multiple subscriptions to the source stream. Subscribers to the input source will receive all notifications of the source from the time of the subscription forward.
Example :

Use ConnectableObservable const seconds = Rx.Observable.interval(1000); const connectableSeconds = seconds.multicast(new Subject());

connectableSeconds.subscribe(value => console.log('first: ' + value)); connectableSeconds.subscribe(value => console.log('second: ' + value));

// At this point still nothing happens, even though we subscribed twice.

connectableSeconds.connect();

// From now on seconds are being logged to the console, // twice per every second. seconds Observable was however only subscribed once, // so under the hood Observable.interval had only one clock started.

Use selector const seconds = Rx.Observable.interval(1000);

seconds .multicast( () => new Subject(), seconds => seconds.zip(seconds) // Usually zip would subscribe to seconds twice. // Because we are inside selector, seconds is subscribed once, ) // thus starting only one clock used internally by Observable.interval. .subscribe();

multicast
multicast(this: typeReference, subjectOrSubjectFactory: typeReference)
Parameters :
Name Type Optional Description
this typeReference
subjectOrSubjectFactory typeReference
multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true

node_modules__/rxjs/src/operator/multicast.ts

multicast
multicast(this: typeReference, subjectOrSubjectFactory: undefined, selector?: undefined)

Allows source Observable to be subscribed only once with a Subject of choice, while still sharing its values between multiple subscribers.

Subscribe to Observable once, but send its values to multiple subscribers.

multicast is an operator that works in two modes.

In the first mode you provide a single argument to it, which can be either an initialized Subject or a Subject factory. As a result you will get a special kind of an Observable - a ConnectableObservable. It can be subscribed multiple times, just as regular Observable, but it won't subscribe to the source Observable at that moment. It will do it only if you call its connect method. This means you can essentially control by hand, when source Observable will be actually subscribed. What is more, ConnectableObservable will share this one subscription between all of its subscribers. This means that, for example, ajax Observable will only send a request once, even though usually it would send a request per every subscriber. Since it sends a request at the moment of subscription, here request would be sent when the connect method of a ConnectableObservable is called.

The most common pattern of using ConnectableObservable is calling connect when the first consumer subscribes, keeping the subscription alive while several consumers come and go and finally unsubscribing from the source Observable, when the last consumer unsubscribes. To not implement that logic over and over again, ConnectableObservable has a special operator, refCount. When called, it returns an Observable, which will count the number of consumers subscribed to it and keep ConnectableObservable connected as long as there is at least one consumer. So if you don't actually need to decide yourself when to connect and disconnect a ConnectableObservable, use refCount.

The second mode is invoked by calling multicast with an additional, second argument - selector function. This function accepts an Observable - which basically mirrors the source Observable - and returns Observable as well, which should be the input stream modified by any operators you want. Note that in this mode you cannot provide initialized Subject as a first argument - it has to be a Subject factory. If you provide selector function, multicast returns just a regular Observable, instead of ConnectableObservable. Thus, as usual, each subscription to this stream triggers subscription to the source Observable. However, if inside the selector function you subscribe to the input Observable multiple times, actual source stream will be subscribed only once. So if you have a chain of operators that use some Observable many times, but you want to subscribe to that Observable only once, this is the mode you would use.

Subject provided as a first parameter of multicast is used as a proxy for the single subscription to the source Observable. It means that all values from the source stream go through that Subject. Thus, if a Subject has some special properties, Observable returned by multicast will have them as well. If you want to use multicast with a Subject that is one of the ones included in RxJS by default - Subject, AsyncSubject, BehaviorSubject, or ReplaySubject - simply use {@link publish}, {@link publishLast}, {@link publishBehavior} or {@link publishReplay} respectively. These are actually just wrappers around multicast, with a specific Subject hardcoded inside.

Also, if you use {@link publish} or {@link publishReplay} with a ConnectableObservables refCount operator, you can simply use {@link share} and {@link shareReplay} respectively, which chain these two.

Parameters :
Name Type Optional Description
this typeReference
subjectOrSubjectFactory
  • Factory function to create an intermediate Subject through which the source sequence's elements will be multicast to the selector function input Observable or ConnectableObservable returned by the operator.
selector true
  • Optional selector function that can use the input stream as many times as needed, without causing multiple subscriptions to the source stream. Subscribers to the input source will receive all notifications of the source from the time of the subscription forward.
Example :

Use ConnectableObservable const seconds = Rx.Observable.interval(1000); const connectableSeconds = seconds.multicast(new Subject());

connectableSeconds.subscribe(value => console.log('first: ' + value)); connectableSeconds.subscribe(value => console.log('second: ' + value));

// At this point still nothing happens, even though we subscribed twice.

connectableSeconds.connect();

// From now on seconds are being logged to the console, // twice per every second. seconds Observable was however only subscribed once, // so under the hood Observable.interval had only one clock started.

Use selector const seconds = Rx.Observable.interval(1000);

seconds .multicast( () => new Subject(), seconds => seconds.zip(seconds) // Usually zip would subscribe to seconds twice. // Because we are inside selector, seconds is subscribed once, ) // thus starting only one clock used internally by Observable.interval. .subscribe();

multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true
multicast
multicast(SubjectFactory: undefined, selector?: typeReference)
Parameters :
Name Type Optional Description
SubjectFactory
selector typeReference true
multicast
multicast(this: typeReference, subjectOrSubjectFactory: typeReference)
Parameters :
Name Type Optional Description
this typeReference
subjectOrSubjectFactory typeReference

node_modules__/rxjs/src/util/noop.ts

noop
noop()

node_modules_/rxjs/src/util/noop.ts

noop
noop()

node_modules__/rxjs/src/util/not.ts

not
not(pred: typeReference, thisArg: any)
Parameters :
Name Type Optional Description
pred typeReference
thisArg any

node_modules_/rxjs/src/util/not.ts

not
not(pred: typeReference, thisArg: any)
Parameters :
Name Type Optional Description
pred typeReference
thisArg any

node_modules__/rxjs/src/operator/observeOn.ts

observeOn
observeOn(this: typeReference, scheduler: typeReference, delay: number)

Re-emits all notifications from source Observable with specified scheduler.

Ensure a specific scheduler is used, from outside of an Observable.

observeOn is an operator that accepts a scheduler as a first parameter, which will be used to reschedule notifications emitted by the source Observable. It might be useful, if you do not have control over internal scheduler of a given Observable, but want to control when its values are emitted nevertheless.

Returned Observable emits the same notifications (nexted values, complete and error events) as the source Observable, but rescheduled with provided scheduler. Note that this doesn't mean that source Observables internal scheduler will be replaced in any way. Original scheduler still will be used, but when the source Observable emits notification, it will be immediately scheduled again - this time with scheduler passed to observeOn. An anti-pattern would be calling observeOn on Observable that emits lots of values synchronously, to split that emissions into asynchronous chunks. For this to happen, scheduler would have to be passed into the source Observable directly (usually into the operator that creates it). observeOn simply delays notifications a little bit more, to ensure that they are emitted at expected moments.

As a matter of fact, observeOn accepts second parameter, which specifies in milliseconds with what delay notifications will be emitted. The main difference between {@link delay} operator and observeOn is that observeOn will delay all notifications - including error notifications - while delay will pass through error from source Observable immediately when it is emitted. In general it is highly recommended to use delay operator for any kind of delaying of values in the stream, while using observeOn to specify which scheduler should be used for notification emissions in general.

Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference

Scheduler that will be used to reschedule notifications from source Observable.

delay number

Number of milliseconds that states with what delay every notification should be rescheduled.

Example :

Ensure values in subscribe are called just before browser repaint. const intervals = Rx.Observable.interval(10); // Intervals are scheduled // with async scheduler by default...

intervals .observeOn(Rx.Scheduler.animationFrame) // ...but we will observe on animationFrame .subscribe(val => { // scheduler to ensure smooth animation. someDiv.style.height = val + 'px'; });

node_modules_/rxjs/src/operator/observeOn.ts

observeOn
observeOn(this: typeReference, scheduler: typeReference, delay: number)

Re-emits all notifications from source Observable with specified scheduler.

Ensure a specific scheduler is used, from outside of an Observable.

observeOn is an operator that accepts a scheduler as a first parameter, which will be used to reschedule notifications emitted by the source Observable. It might be useful, if you do not have control over internal scheduler of a given Observable, but want to control when its values are emitted nevertheless.

Returned Observable emits the same notifications (nexted values, complete and error events) as the source Observable, but rescheduled with provided scheduler. Note that this doesn't mean that source Observables internal scheduler will be replaced in any way. Original scheduler still will be used, but when the source Observable emits notification, it will be immediately scheduled again - this time with scheduler passed to observeOn. An anti-pattern would be calling observeOn on Observable that emits lots of values synchronously, to split that emissions into asynchronous chunks. For this to happen, scheduler would have to be passed into the source Observable directly (usually into the operator that creates it). observeOn simply delays notifications a little bit more, to ensure that they are emitted at expected moments.

As a matter of fact, observeOn accepts second parameter, which specifies in milliseconds with what delay notifications will be emitted. The main difference between {@link delay} operator and observeOn is that observeOn will delay all notifications - including error notifications - while delay will pass through error from source Observable immediately when it is emitted. In general it is highly recommended to use delay operator for any kind of delaying of values in the stream, while using observeOn to specify which scheduler should be used for notification emissions in general.

Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference

Scheduler that will be used to reschedule notifications from source Observable.

delay number

Number of milliseconds that states with what delay every notification should be rescheduled.

Example :

Ensure values in subscribe are called just before browser repaint. const intervals = Rx.Observable.interval(10); // Intervals are scheduled // with async scheduler by default...

intervals .observeOn(Rx.Scheduler.animationFrame) // ...but we will observe on animationFrame .subscribe(val => { // scheduler to ensure smooth animation. someDiv.style.height = val + 'px'; });

node_modules_/rxjs/src/operators/observeOn.ts

observeOn
observeOn(scheduler: typeReference, delay: number)

Re-emits all notifications from source Observable with specified scheduler.

Ensure a specific scheduler is used, from outside of an Observable.

observeOn is an operator that accepts a scheduler as a first parameter, which will be used to reschedule notifications emitted by the source Observable. It might be useful, if you do not have control over internal scheduler of a given Observable, but want to control when its values are emitted nevertheless.

Returned Observable emits the same notifications (nexted values, complete and error events) as the source Observable, but rescheduled with provided scheduler. Note that this doesn't mean that source Observables internal scheduler will be replaced in any way. Original scheduler still will be used, but when the source Observable emits notification, it will be immediately scheduled again - this time with scheduler passed to observeOn. An anti-pattern would be calling observeOn on Observable that emits lots of values synchronously, to split that emissions into asynchronous chunks. For this to happen, scheduler would have to be passed into the source Observable directly (usually into the operator that creates it). observeOn simply delays notifications a little bit more, to ensure that they are emitted at expected moments.

As a matter of fact, observeOn accepts second parameter, which specifies in milliseconds with what delay notifications will be emitted. The main difference between {@link delay} operator and observeOn is that observeOn will delay all notifications - including error notifications - while delay will pass through error from source Observable immediately when it is emitted. In general it is highly recommended to use delay operator for any kind of delaying of values in the stream, while using observeOn to specify which scheduler should be used for notification emissions in general.

Parameters :
Name Type Optional Description
scheduler typeReference

Scheduler that will be used to reschedule notifications from source Observable.

delay number

Number of milliseconds that states with what delay every notification should be rescheduled.

Example :

Ensure values in subscribe are called just before browser repaint. const intervals = Rx.Observable.interval(10); // Intervals are scheduled // with async scheduler by default...

intervals .observeOn(Rx.Scheduler.animationFrame) // ...but we will observe on animationFrame .subscribe(val => { // scheduler to ensure smooth animation. someDiv.style.height = val + 'px'; });

node_modules__/rxjs/src/operators/observeOn.ts

observeOn
observeOn(scheduler: typeReference, delay: number)

Re-emits all notifications from source Observable with specified scheduler.

Ensure a specific scheduler is used, from outside of an Observable.

observeOn is an operator that accepts a scheduler as a first parameter, which will be used to reschedule notifications emitted by the source Observable. It might be useful, if you do not have control over internal scheduler of a given Observable, but want to control when its values are emitted nevertheless.

Returned Observable emits the same notifications (nexted values, complete and error events) as the source Observable, but rescheduled with provided scheduler. Note that this doesn't mean that source Observables internal scheduler will be replaced in any way. Original scheduler still will be used, but when the source Observable emits notification, it will be immediately scheduled again - this time with scheduler passed to observeOn. An anti-pattern would be calling observeOn on Observable that emits lots of values synchronously, to split that emissions into asynchronous chunks. For this to happen, scheduler would have to be passed into the source Observable directly (usually into the operator that creates it). observeOn simply delays notifications a little bit more, to ensure that they are emitted at expected moments.

As a matter of fact, observeOn accepts second parameter, which specifies in milliseconds with what delay notifications will be emitted. The main difference between {@link delay} operator and observeOn is that observeOn will delay all notifications - including error notifications - while delay will pass through error from source Observable immediately when it is emitted. In general it is highly recommended to use delay operator for any kind of delaying of values in the stream, while using observeOn to specify which scheduler should be used for notification emissions in general.

Parameters :
Name Type Optional Description
scheduler typeReference

Scheduler that will be used to reschedule notifications from source Observable.

delay number

Number of milliseconds that states with what delay every notification should be rescheduled.

Example :

Ensure values in subscribe are called just before browser repaint. const intervals = Rx.Observable.interval(10); // Intervals are scheduled // with async scheduler by default...

intervals .observeOn(Rx.Scheduler.animationFrame) // ...but we will observe on animationFrame .subscribe(val => { // scheduler to ensure smooth animation. someDiv.style.height = val + 'px'; });

node_modules__/rxjs/src/operators/onErrorResumeNext.ts

onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
onErrorResumeNext
onErrorResumeNext(v: typeReference)
Parameters :
Name Type Optional Description
v typeReference
onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
onErrorResumeNext
onErrorResumeNext(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
onErrorResumeNext
onErrorResumeNext(array: undefined)
Parameters :
Name Type Optional Description
array
onErrorResumeNext
onErrorResumeNext(nextSources: typeReference)

When any of the provided Observable emits an complete or error notification, it immediately subscribes to the next one that was passed.

Execute series of Observables no matter what, even if it means swallowing errors.

onErrorResumeNext is an operator that accepts a series of Observables, provided either directly as arguments or as an array. If no single Observable is provided, returned Observable will simply behave the same as the source.

onErrorResumeNext returns an Observable that starts by subscribing and re-emitting values from the source Observable. When its stream of values ends - no matter if Observable completed or emitted an error - onErrorResumeNext will subscribe to the first Observable that was passed as an argument to the method. It will start re-emitting its values as well and - again - when that stream ends, onErrorResumeNext will proceed to subscribing yet another Observable in provided series, no matter if previous Observable completed or ended with an error. This will be happening until there is no more Observables left in the series, at which point returned Observable will complete - even if the last subscribed stream ended with an error.

onErrorResumeNext can be therefore thought of as version of {@link concat} operator, which is more permissive when it comes to the errors emitted by its input Observables. While concat subscribes to the next Observable in series only if previous one successfully completed, onErrorResumeNext subscribes even if it ended with an error.

Note that you do not get any access to errors emitted by the Observables. In particular do not expect these errors to appear in error callback passed to {@link subscribe}. If you want to take specific actions based on what error was emitted by an Observable, you should try out {@link catch} instead.

Parameters :
Name Type Optional Description
nextSources typeReference
Example :

Subscribe to the next Observable after map fails Rx.Observable.of(1, 2, 3, 0) .map(x => { if (x === 0) { throw Error(); } return 10 / x; }) .onErrorResumeNext(Rx.Observable.of(1, 2, 3)) .subscribe( val => console.log(val), err => console.log(err), // Will never be called. () => console.log('that\'s it!') );

// Logs: // 10 // 5 // 3.3333333333333335 // 1 // 2 // 3 // "that's it!"

onErrorResumeNextStatic
onErrorResumeNextStatic(v: typeReference)
Parameters :
Name Type Optional Description
v typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(array: undefined)
Parameters :
Name Type Optional Description
array
onErrorResumeNextStatic
onErrorResumeNextStatic(nextSources: typeReference)
Parameters :
Name Type Optional Description
nextSources typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference

node_modules__/rxjs/src/operator/onErrorResumeNext.ts

onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, array: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
onErrorResumeNext
onErrorResumeNext(this: typeReference, nextSources: typeReference)

When any of the provided Observable emits an complete or error notification, it immediately subscribes to the next one that was passed.

Execute series of Observables no matter what, even if it means swallowing errors.

onErrorResumeNext is an operator that accepts a series of Observables, provided either directly as arguments or as an array. If no single Observable is provided, returned Observable will simply behave the same as the source.

onErrorResumeNext returns an Observable that starts by subscribing and re-emitting values from the source Observable. When its stream of values ends - no matter if Observable completed or emitted an error - onErrorResumeNext will subscribe to the first Observable that was passed as an argument to the method. It will start re-emitting its values as well and - again - when that stream ends, onErrorResumeNext will proceed to subscribing yet another Observable in provided series, no matter if previous Observable completed or ended with an error. This will be happening until there is no more Observables left in the series, at which point returned Observable will complete - even if the last subscribed stream ended with an error.

onErrorResumeNext can be therefore thought of as version of {@link concat} operator, which is more permissive when it comes to the errors emitted by its input Observables. While concat subscribes to the next Observable in series only if previous one successfully completed, onErrorResumeNext subscribes even if it ended with an error.

Note that you do not get any access to errors emitted by the Observables. In particular do not expect these errors to appear in error callback passed to {@link subscribe}. If you want to take specific actions based on what error was emitted by an Observable, you should try out {@link catch} instead.

Parameters :
Name Type Optional Description
this typeReference
nextSources typeReference
Example :

Subscribe to the next Observable after map fails Rx.Observable.of(1, 2, 3, 0) .map(x => { if (x === 0) { throw Error(); } return 10 / x; }) .onErrorResumeNext(Rx.Observable.of(1, 2, 3)) .subscribe( val => console.log(val), err => console.log(err), // Will never be called. () => console.log('that\'s it!') );

// Logs: // 10 // 5 // 3.3333333333333335 // 1 // 2 // 3 // "that's it!"

node_modules_/rxjs/src/operators/onErrorResumeNext.ts

onErrorResumeNext
onErrorResumeNext(nextSources: typeReference)

When any of the provided Observable emits an complete or error notification, it immediately subscribes to the next one that was passed.

Execute series of Observables no matter what, even if it means swallowing errors.

onErrorResumeNext is an operator that accepts a series of Observables, provided either directly as arguments or as an array. If no single Observable is provided, returned Observable will simply behave the same as the source.

onErrorResumeNext returns an Observable that starts by subscribing and re-emitting values from the source Observable. When its stream of values ends - no matter if Observable completed or emitted an error - onErrorResumeNext will subscribe to the first Observable that was passed as an argument to the method. It will start re-emitting its values as well and - again - when that stream ends, onErrorResumeNext will proceed to subscribing yet another Observable in provided series, no matter if previous Observable completed or ended with an error. This will be happening until there is no more Observables left in the series, at which point returned Observable will complete - even if the last subscribed stream ended with an error.

onErrorResumeNext can be therefore thought of as version of {@link concat} operator, which is more permissive when it comes to the errors emitted by its input Observables. While concat subscribes to the next Observable in series only if previous one successfully completed, onErrorResumeNext subscribes even if it ended with an error.

Note that you do not get any access to errors emitted by the Observables. In particular do not expect these errors to appear in error callback passed to {@link subscribe}. If you want to take specific actions based on what error was emitted by an Observable, you should try out {@link catch} instead.

Parameters :
Name Type Optional Description
nextSources typeReference
Example :

Subscribe to the next Observable after map fails Rx.Observable.of(1, 2, 3, 0) .map(x => { if (x === 0) { throw Error(); } return 10 / x; }) .onErrorResumeNext(Rx.Observable.of(1, 2, 3)) .subscribe( val => console.log(val), err => console.log(err), // Will never be called. () => console.log('that\'s it!') );

// Logs: // 10 // 5 // 3.3333333333333335 // 1 // 2 // 3 // "that's it!"

onErrorResumeNext
onErrorResumeNext(array: undefined)
Parameters :
Name Type Optional Description
array
onErrorResumeNext
onErrorResumeNext(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
onErrorResumeNext
onErrorResumeNext(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
onErrorResumeNext
onErrorResumeNext(v: typeReference)
Parameters :
Name Type Optional Description
v typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(nextSources: typeReference)
Parameters :
Name Type Optional Description
nextSources typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(v: typeReference)
Parameters :
Name Type Optional Description
v typeReference
onErrorResumeNextStatic
onErrorResumeNextStatic(array: undefined)
Parameters :
Name Type Optional Description
array

node_modules_/rxjs/src/operator/onErrorResumeNext.ts

onErrorResumeNext
onErrorResumeNext(this: typeReference, v: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
onErrorResumeNext
onErrorResumeNext(this: typeReference, array: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
onErrorResumeNext
onErrorResumeNext(this: typeReference, nextSources: typeReference)

When any of the provided Observable emits an complete or error notification, it immediately subscribes to the next one that was passed.

Execute series of Observables no matter what, even if it means swallowing errors.

onErrorResumeNext is an operator that accepts a series of Observables, provided either directly as arguments or as an array. If no single Observable is provided, returned Observable will simply behave the same as the source.

onErrorResumeNext returns an Observable that starts by subscribing and re-emitting values from the source Observable. When its stream of values ends - no matter if Observable completed or emitted an error - onErrorResumeNext will subscribe to the first Observable that was passed as an argument to the method. It will start re-emitting its values as well and - again - when that stream ends, onErrorResumeNext will proceed to subscribing yet another Observable in provided series, no matter if previous Observable completed or ended with an error. This will be happening until there is no more Observables left in the series, at which point returned Observable will complete - even if the last subscribed stream ended with an error.

onErrorResumeNext can be therefore thought of as version of {@link concat} operator, which is more permissive when it comes to the errors emitted by its input Observables. While concat subscribes to the next Observable in series only if previous one successfully completed, onErrorResumeNext subscribes even if it ended with an error.

Note that you do not get any access to errors emitted by the Observables. In particular do not expect these errors to appear in error callback passed to {@link subscribe}. If you want to take specific actions based on what error was emitted by an Observable, you should try out {@link catch} instead.

Parameters :
Name Type Optional Description
this typeReference
nextSources typeReference
Example :

Subscribe to the next Observable after map fails Rx.Observable.of(1, 2, 3, 0) .map(x => { if (x === 0) { throw Error(); } return 10 / x; }) .onErrorResumeNext(Rx.Observable.of(1, 2, 3)) .subscribe( val => console.log(val), err => console.log(err), // Will never be called. () => console.log('that\'s it!') );

// Logs: // 10 // 5 // 3.3333333333333335 // 1 // 2 // 3 // "that's it!"

node_modules_/rxjs/src/operators/pairwise.ts

pairwise
pairwise()

Groups pairs of consecutive emissions together and emits them as an array of two values.

Puts the current value and previous value together as an array, and emits that.

The Nth emission from the source Observable will cause the output Observable to emit an array [(N-1)th, Nth] of the previous and the current value, as a pair. For this reason, pairwise emits on the second and subsequent emissions from the source Observable, but not on the first emission, because there is no previous value in that case.

Example :

On every click (starting from the second), emit the relative distance to the previous click var clicks = Rx.Observable.fromEvent(document, 'click'); var pairs = clicks.pairwise(); var distance = pairs.map(pair => { var x0 = pair[0].clientX; var y0 = pair[0].clientY; var x1 = pair[1].clientX; var y1 = pair[1].clientY; return Math.sqrt(Math.pow(x0 - x1, 2) + Math.pow(y0 - y1, 2)); }); distance.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/pairwise.ts

pairwise
pairwise(this: typeReference)

Groups pairs of consecutive emissions together and emits them as an array of two values.

Puts the current value and previous value together as an array, and emits that.

The Nth emission from the source Observable will cause the output Observable to emit an array [(N-1)th, Nth] of the previous and the current value, as a pair. For this reason, pairwise emits on the second and subsequent emissions from the source Observable, but not on the first emission, because there is no previous value in that case.

Parameters :
Name Type Optional Description
this typeReference
Example :

On every click (starting from the second), emit the relative distance to the previous click var clicks = Rx.Observable.fromEvent(document, 'click'); var pairs = clicks.pairwise(); var distance = pairs.map(pair => { var x0 = pair[0].clientX; var y0 = pair[0].clientY; var x1 = pair[1].clientX; var y1 = pair[1].clientY; return Math.sqrt(Math.pow(x0 - x1, 2) + Math.pow(y0 - y1, 2)); }); distance.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/pairwise.ts

pairwise
pairwise(this: typeReference)

Groups pairs of consecutive emissions together and emits them as an array of two values.

Puts the current value and previous value together as an array, and emits that.

The Nth emission from the source Observable will cause the output Observable to emit an array [(N-1)th, Nth] of the previous and the current value, as a pair. For this reason, pairwise emits on the second and subsequent emissions from the source Observable, but not on the first emission, because there is no previous value in that case.

Parameters :
Name Type Optional Description
this typeReference
Example :

On every click (starting from the second), emit the relative distance to the previous click var clicks = Rx.Observable.fromEvent(document, 'click'); var pairs = clicks.pairwise(); var distance = pairs.map(pair => { var x0 = pair[0].clientX; var y0 = pair[0].clientY; var x1 = pair[1].clientX; var y1 = pair[1].clientY; return Math.sqrt(Math.pow(x0 - x1, 2) + Math.pow(y0 - y1, 2)); }); distance.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/pairwise.ts

pairwise
pairwise()

Groups pairs of consecutive emissions together and emits them as an array of two values.

Puts the current value and previous value together as an array, and emits that.

The Nth emission from the source Observable will cause the output Observable to emit an array [(N-1)th, Nth] of the previous and the current value, as a pair. For this reason, pairwise emits on the second and subsequent emissions from the source Observable, but not on the first emission, because there is no previous value in that case.

Example :

On every click (starting from the second), emit the relative distance to the previous click var clicks = Rx.Observable.fromEvent(document, 'click'); var pairs = clicks.pairwise(); var distance = pairs.map(pair => { var x0 = pair[0].clientX; var y0 = pair[0].clientY; var x1 = pair[1].clientX; var y1 = pair[1].clientY; return Math.sqrt(Math.pow(x0 - x1, 2) + Math.pow(y0 - y1, 2)); }); distance.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/partition.ts

partition
partition(predicate: undefined, thisArg?: any)

Splits the source Observable into two, one with values that satisfy a predicate, and another with values that don't satisfy the predicate.

It's like {@link filter}, but returns two Observables: one like the output of {@link filter}, and the other with values that did not pass the condition.

partition outputs an array with two Observables that partition the values from the source Observable through the given predicate function. The first Observable in that array emits source values for which the predicate argument returns true. The second Observable emits source values for which the predicate returns false. The first behaves like {@link filter} and the second behaves like {@link filter} with the predicate negated.

Parameters :
Name Type Optional Description
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted on the first Observable in the returned array, if false the value is emitted on the second Observable in the array. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Partition click events into those on DIV elements and those elsewhere var clicks = Rx.Observable.fromEvent(document, 'click'); var parts = clicks.partition(ev => ev.target.tagName === 'DIV'); var clicksOnDivs = parts[0]; var clicksElsewhere = parts[1]; clicksOnDivs.subscribe(x => console.log('DIV clicked: ', x)); clicksElsewhere.subscribe(x => console.log('Other clicked: ', x));

node_modules__/rxjs/src/operator/partition.ts

partition
partition(this: typeReference, predicate: undefined, thisArg?: any)

Splits the source Observable into two, one with values that satisfy a predicate, and another with values that don't satisfy the predicate.

It's like {@link filter}, but returns two Observables: one like the output of {@link filter}, and the other with values that did not pass the condition.

partition outputs an array with two Observables that partition the values from the source Observable through the given predicate function. The first Observable in that array emits source values for which the predicate argument returns true. The second Observable emits source values for which the predicate returns false. The first behaves like {@link filter} and the second behaves like {@link filter} with the predicate negated.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted on the first Observable in the returned array, if false the value is emitted on the second Observable in the array. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Partition click events into those on DIV elements and those elsewhere var clicks = Rx.Observable.fromEvent(document, 'click'); var parts = clicks.partition(ev => ev.target.tagName === 'DIV'); var clicksOnDivs = parts[0]; var clicksElsewhere = parts[1]; clicksOnDivs.subscribe(x => console.log('DIV clicked: ', x)); clicksElsewhere.subscribe(x => console.log('Other clicked: ', x));

node_modules__/rxjs/src/operators/partition.ts

partition
partition(predicate: undefined, thisArg?: any)

Splits the source Observable into two, one with values that satisfy a predicate, and another with values that don't satisfy the predicate.

It's like {@link filter}, but returns two Observables: one like the output of {@link filter}, and the other with values that did not pass the condition.

partition outputs an array with two Observables that partition the values from the source Observable through the given predicate function. The first Observable in that array emits source values for which the predicate argument returns true. The second Observable emits source values for which the predicate returns false. The first behaves like {@link filter} and the second behaves like {@link filter} with the predicate negated.

Parameters :
Name Type Optional Description
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted on the first Observable in the returned array, if false the value is emitted on the second Observable in the array. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Partition click events into those on DIV elements and those elsewhere var clicks = Rx.Observable.fromEvent(document, 'click'); var parts = clicks.partition(ev => ev.target.tagName === 'DIV'); var clicksOnDivs = parts[0]; var clicksElsewhere = parts[1]; clicksOnDivs.subscribe(x => console.log('DIV clicked: ', x)); clicksElsewhere.subscribe(x => console.log('Other clicked: ', x));

node_modules_/rxjs/src/operator/partition.ts

partition
partition(this: typeReference, predicate: undefined, thisArg?: any)

Splits the source Observable into two, one with values that satisfy a predicate, and another with values that don't satisfy the predicate.

It's like {@link filter}, but returns two Observables: one like the output of {@link filter}, and the other with values that did not pass the condition.

partition outputs an array with two Observables that partition the values from the source Observable through the given predicate function. The first Observable in that array emits source values for which the predicate argument returns true. The second Observable emits source values for which the predicate returns false. The first behaves like {@link filter} and the second behaves like {@link filter} with the predicate negated.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted on the first Observable in the returned array, if false the value is emitted on the second Observable in the array. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.

thisArg any true

An optional argument to determine the value of this in the predicate function.

Example :

Partition click events into those on DIV elements and those elsewhere var clicks = Rx.Observable.fromEvent(document, 'click'); var parts = clicks.partition(ev => ev.target.tagName === 'DIV'); var clicksOnDivs = parts[0]; var clicksElsewhere = parts[1]; clicksOnDivs.subscribe(x => console.log('DIV clicked: ', x)); clicksElsewhere.subscribe(x => console.log('Other clicked: ', x));

node_modules_/zone.js/lib/common/timers.ts

patchTimer
patchTimer(window: any, setName: string, cancelName: string, nameSuffix: string)
Parameters :
Name Type Optional Description
window any
setName string
cancelName string
nameSuffix string

node_modules__/zone.js/lib/common/timers.ts

patchTimer
patchTimer(window: any, setName: string, cancelName: string, nameSuffix: string)
Parameters :
Name Type Optional Description
window any
setName string
cancelName string
nameSuffix string

node_modules_/rxjs/src/util/pipe.ts

pipe
pipe(fns: typeReference)
Parameters :
Name Type Optional Description
fns typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference, op7: typeReference, op8: typeReference, op9: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
op7 typeReference
op8 typeReference
op9 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference, op7: typeReference, op8: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
op7 typeReference
op8 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference, op7: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
op7 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
pipe
pipe(op1: typeReference, op2: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
pipe
pipe()
pipe
pipe(op1: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
pipeFromArray
pipeFromArray(fns: typeReference)
Parameters :
Name Type Optional Description
fns typeReference

node_modules__/rxjs/src/util/pipe.ts

pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
pipe
pipe(op1: typeReference, op2: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference, op7: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
op7 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
pipe
pipe()
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference, op7: typeReference, op8: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
op7 typeReference
op8 typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference, op5: typeReference, op6: typeReference, op7: typeReference, op8: typeReference, op9: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
op5 typeReference
op6 typeReference
op7 typeReference
op8 typeReference
op9 typeReference
pipe
pipe(op1: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
pipe
pipe(fns: typeReference)
Parameters :
Name Type Optional Description
fns typeReference
pipe
pipe(op1: typeReference, op2: typeReference, op3: typeReference, op4: typeReference)
Parameters :
Name Type Optional Description
op1 typeReference
op2 typeReference
op3 typeReference
op4 typeReference
pipeFromArray
pipeFromArray(fns: typeReference)
Parameters :
Name Type Optional Description
fns typeReference

node_modules__/rxjs/src/operators/pluck.ts

pluck
pluck(...properties: undefined)

Maps each source value (an object) to its specified nested property.

Like {@link map}, but meant only for picking one of the nested properties of every emitted object.

Given a list of strings describing a path to an object property, retrieves the value of a specified nested property from all values in the source Observable. If a property can't be resolved, it will return undefined for that value.

Parameters :
Name Type Optional Description
properties

The nested properties to pluck from each source value (an object).

Example :

Map every click to the tagName of the clicked target element var clicks = Rx.Observable.fromEvent(document, 'click'); var tagNames = clicks.pluck('target', 'tagName'); tagNames.subscribe(x => console.log(x));

plucker
plucker(props: undefined, length: number)
Parameters :
Name Type Optional Description
props
length number

node_modules__/rxjs/src/operator/pluck.ts

pluck
pluck(this: typeReference, ...properties: undefined)

Maps each source value (an object) to its specified nested property.

Like {@link map}, but meant only for picking one of the nested properties of every emitted object.

Given a list of strings describing a path to an object property, retrieves the value of a specified nested property from all values in the source Observable. If a property can't be resolved, it will return undefined for that value.

Parameters :
Name Type Optional Description
this typeReference
properties

The nested properties to pluck from each source value (an object).

Example :

Map every click to the tagName of the clicked target element var clicks = Rx.Observable.fromEvent(document, 'click'); var tagNames = clicks.pluck('target', 'tagName'); tagNames.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/pluck.ts

pluck
pluck(this: typeReference, ...properties: undefined)

Maps each source value (an object) to its specified nested property.

Like {@link map}, but meant only for picking one of the nested properties of every emitted object.

Given a list of strings describing a path to an object property, retrieves the value of a specified nested property from all values in the source Observable. If a property can't be resolved, it will return undefined for that value.

Parameters :
Name Type Optional Description
this typeReference
properties

The nested properties to pluck from each source value (an object).

Example :

Map every click to the tagName of the clicked target element var clicks = Rx.Observable.fromEvent(document, 'click'); var tagNames = clicks.pluck('target', 'tagName'); tagNames.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/pluck.ts

pluck
pluck(...properties: undefined)

Maps each source value (an object) to its specified nested property.

Like {@link map}, but meant only for picking one of the nested properties of every emitted object.

Given a list of strings describing a path to an object property, retrieves the value of a specified nested property from all values in the source Observable. If a property can't be resolved, it will return undefined for that value.

Parameters :
Name Type Optional Description
properties

The nested properties to pluck from each source value (an object).

Example :

Map every click to the tagName of the clicked target element var clicks = Rx.Observable.fromEvent(document, 'click'); var tagNames = clicks.pluck('target', 'tagName'); tagNames.subscribe(x => console.log(x));

plucker
plucker(props: undefined, length: number)
Parameters :
Name Type Optional Description
props
length number

node_modules__/@compodoc/compodoc/src/utils/promise-sequential.ts

promiseSequential
promiseSequential(promises: )
Parameters :
Name Type Optional Description
promises

node_modules_/@compodoc/compodoc/src/utils/promise-sequential.ts

promiseSequential
promiseSequential(promises: )
Parameters :
Name Type Optional Description
promises

node_modules__/rxjs/src/operators/publish.ts

publish
publish(selector: typeReference)
Parameters :
Name Type Optional Description
selector typeReference
publish
publish()
publish
publish(selector?: typeReference)

Returns a ConnectableObservable, which is a variety of Observable that waits until its connect method is called before it begins emitting items to those Observers that have subscribed to it.

Parameters :
Name Type Optional Description
selector typeReference true
  • Optional selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all notifications of the source from the time of the subscription on.
publish
publish(selector: typeReference)
Parameters :
Name Type Optional Description
selector typeReference

node_modules_/rxjs/src/operators/publish.ts

publish
publish(selector: typeReference)
Parameters :
Name Type Optional Description
selector typeReference
publish
publish(selector: typeReference)
Parameters :
Name Type Optional Description
selector typeReference
publish
publish()
publish
publish(selector?: typeReference)

Returns a ConnectableObservable, which is a variety of Observable that waits until its connect method is called before it begins emitting items to those Observers that have subscribed to it.

Parameters :
Name Type Optional Description
selector typeReference true
  • Optional selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all notifications of the source from the time of the subscription on.

node_modules__/rxjs/src/operator/publish.ts

publish
publish(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference
publish
publish(this: typeReference, selector: undefined)
Parameters :
Name Type Optional Description
this typeReference
selector
publish
publish(this: typeReference, selector: undefined)
Parameters :
Name Type Optional Description
this typeReference
selector
publish
publish(this: typeReference, selector?: undefined)

Returns a ConnectableObservable, which is a variety of Observable that waits until its connect method is called before it begins emitting items to those Observers that have subscribed to it.

Parameters :
Name Type Optional Description
this typeReference
selector true
  • Optional selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all notifications of the source from the time of the subscription on.

node_modules_/rxjs/src/operator/publish.ts

publish
publish(this: typeReference, selector?: undefined)

Returns a ConnectableObservable, which is a variety of Observable that waits until its connect method is called before it begins emitting items to those Observers that have subscribed to it.

Parameters :
Name Type Optional Description
this typeReference
selector true
  • Optional selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all notifications of the source from the time of the subscription on.
publish
publish(this: typeReference, selector: undefined)
Parameters :
Name Type Optional Description
this typeReference
selector
publish
publish(this: typeReference, selector: undefined)
Parameters :
Name Type Optional Description
this typeReference
selector
publish
publish(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference

node_modules__/rxjs/src/operators/publishBehavior.ts

publishBehavior
publishBehavior(value: typeReference)
Parameters :
Name Type Optional Description
value typeReference

node_modules_/rxjs/src/operator/publishBehavior.ts

publishBehavior
publishBehavior(this: typeReference, value: typeReference)
Parameters :
Name Type Optional Description
this typeReference
value typeReference

node_modules_/rxjs/src/operators/publishBehavior.ts

publishBehavior
publishBehavior(value: typeReference)
Parameters :
Name Type Optional Description
value typeReference

node_modules__/rxjs/src/operator/publishBehavior.ts

publishBehavior
publishBehavior(this: typeReference, value: typeReference)
Parameters :
Name Type Optional Description
this typeReference
value typeReference

node_modules__/rxjs/src/operator/publishLast.ts

publishLast
publishLast(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference

node_modules_/rxjs/src/operator/publishLast.ts

publishLast
publishLast(this: typeReference)
Parameters :
Name Type Optional Description
this typeReference

node_modules__/rxjs/src/operators/publishLast.ts

publishLast
publishLast()

node_modules_/rxjs/src/operators/publishLast.ts

publishLast
publishLast()

node_modules__/rxjs/src/operators/publishReplay.ts

publishReplay
publishReplay(bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
scheduler typeReference true
publishReplay
publishReplay(bufferSize?: number, windowTime?: number, selector?: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
selector typeReference true
scheduler typeReference true
publishReplay
publishReplay(bufferSize?: number, windowTime?: number, selector?: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
selector typeReference true
scheduler typeReference true
publishReplay
publishReplay(bufferSize?: number, windowTime?: number, selectorOrScheduler?: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
selectorOrScheduler true
scheduler typeReference true

node_modules_/rxjs/src/operator/publishReplay.ts

publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, selector?: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
selector typeReference true
scheduler typeReference true
publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, selector?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
selector typeReference true
publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, selectorOrScheduler?: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
selectorOrScheduler true
scheduler typeReference true
publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
scheduler typeReference true

node_modules__/rxjs/src/operator/publishReplay.ts

publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, selector?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
selector typeReference true
publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, selector?: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
selector typeReference true
scheduler typeReference true
publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
scheduler typeReference true
publishReplay
publishReplay(this: typeReference, bufferSize?: number, windowTime?: number, selectorOrScheduler?: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
selectorOrScheduler true
scheduler typeReference true

node_modules_/rxjs/src/operators/publishReplay.ts

publishReplay
publishReplay(bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
scheduler typeReference true
publishReplay
publishReplay(bufferSize?: number, windowTime?: number, selector?: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
selector typeReference true
scheduler typeReference true
publishReplay
publishReplay(bufferSize?: number, windowTime?: number, selector?: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
selector typeReference true
scheduler typeReference true
publishReplay
publishReplay(bufferSize?: number, windowTime?: number, selectorOrScheduler?: undefined, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
selectorOrScheduler true
scheduler typeReference true

node_modules_/rxjs/src/operator/race.ts

race
race(this: typeReference, observables: typeReference)

Returns an Observable that mirrors the first source Observable to emit an item from the combination of this Observable and supplied Observables.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference

node_modules_/rxjs/src/observable/race.ts

race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)

Returns an Observable that mirrors the first source Observable to emit an item.

Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference

node_modules__/rxjs/src/observable/race.ts

race
race(observables: typeReference)

Returns an Observable that mirrors the first source Observable to emit an item.

Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference

node_modules__/rxjs/src/operators/race.ts

race
race(observables: typeReference)

Returns an Observable that mirrors the first source Observable to emit an item from the combination of this Observable and supplied Observables.

Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference

node_modules__/rxjs/src/operator/race.ts

race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
race
race(this: typeReference, observables: typeReference)

Returns an Observable that mirrors the first source Observable to emit an item from the combination of this Observable and supplied Observables.

Parameters :
Name Type Optional Description
this typeReference
observables typeReference

node_modules_/rxjs/src/operators/race.ts

race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
race
race(observables: typeReference)

Returns an Observable that mirrors the first source Observable to emit an item from the combination of this Observable and supplied Observables.

Parameters :
Name Type Optional Description
observables typeReference

node_modules_/rxjs/src/operator/reduce.ts

reduce
reduce(this: typeReference, accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference true
reduce
reduce(this: typeReference, accumulator: undefined, seed: undefined)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed
reduce
reduce(this: typeReference, accumulator: undefined, seed: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference
reduce
reduce(this: typeReference, accumulator: undefined, seed?: typeReference)

Applies an accumulator function over the source Observable, and returns the accumulated result when the source completes, given an optional seed value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past.

Like Array.prototype.reduce(), reduce applies an accumulator function against an accumulation and each value of the source Observable (from the past) to reduce it to a single value, emitted on the output Observable. Note that reduce will only emit one value, only when the source Observable completes. It is equivalent to applying operator {@link scan} followed by operator {@link last}.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
this typeReference
accumulator

The accumulator function called on each source value.

seed typeReference true

The initial accumulation value.

Example :

Count the number of click events that happened in 5 seconds var clicksInFiveSeconds = Rx.Observable.fromEvent(document, 'click') .takeUntil(Rx.Observable.interval(5000)); var ones = clicksInFiveSeconds.mapTo(1); var seed = 0; var count = ones.reduce((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/reduce.ts

reduce
reduce(this: typeReference, accumulator: undefined, seed?: typeReference)

Applies an accumulator function over the source Observable, and returns the accumulated result when the source completes, given an optional seed value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past.

Like Array.prototype.reduce(), reduce applies an accumulator function against an accumulation and each value of the source Observable (from the past) to reduce it to a single value, emitted on the output Observable. Note that reduce will only emit one value, only when the source Observable completes. It is equivalent to applying operator {@link scan} followed by operator {@link last}.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
this typeReference
accumulator

The accumulator function called on each source value.

seed typeReference true

The initial accumulation value.

Example :

Count the number of click events that happened in 5 seconds var clicksInFiveSeconds = Rx.Observable.fromEvent(document, 'click') .takeUntil(Rx.Observable.interval(5000)); var ones = clicksInFiveSeconds.mapTo(1); var seed = 0; var count = ones.reduce((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

reduce
reduce(this: typeReference, accumulator: undefined, seed: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference
reduce
reduce(this: typeReference, accumulator: undefined, seed: undefined)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed
reduce
reduce(this: typeReference, accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference true

node_modules__/rxjs/src/operators/reduce.ts

reduce
reduce(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true
reduce
reduce(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true
reduce
reduce(accumulator: undefined, seed: undefined)
Parameters :
Name Type Optional Description
accumulator
seed
reduce
reduce(accumulator: undefined, seed?: typeReference)

Applies an accumulator function over the source Observable, and returns the accumulated result when the source completes, given an optional seed value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past.

Like Array.prototype.reduce(), reduce applies an accumulator function against an accumulation and each value of the source Observable (from the past) to reduce it to a single value, emitted on the output Observable. Note that reduce will only emit one value, only when the source Observable completes. It is equivalent to applying operator {@link scan} followed by operator {@link last}.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
accumulator

The accumulator function called on each source value.

seed typeReference true

The initial accumulation value.

Example :

Count the number of click events that happened in 5 seconds var clicksInFiveSeconds = Rx.Observable.fromEvent(document, 'click') .takeUntil(Rx.Observable.interval(5000)); var ones = clicksInFiveSeconds.mapTo(1); var seed = 0; var count = ones.reduce((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/reduce.ts

reduce
reduce(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true
reduce
reduce(accumulator: undefined, seed: undefined)
Parameters :
Name Type Optional Description
accumulator
seed
reduce
reduce(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true
reduce
reduce(accumulator: undefined, seed?: typeReference)

Applies an accumulator function over the source Observable, and returns the accumulated result when the source completes, given an optional seed value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past.

Like Array.prototype.reduce(), reduce applies an accumulator function against an accumulation and each value of the source Observable (from the past) to reduce it to a single value, emitted on the output Observable. Note that reduce will only emit one value, only when the source Observable completes. It is equivalent to applying operator {@link scan} followed by operator {@link last}.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
accumulator

The accumulator function called on each source value.

seed typeReference true

The initial accumulation value.

Example :

Count the number of click events that happened in 5 seconds var clicksInFiveSeconds = Rx.Observable.fromEvent(document, 'click') .takeUntil(Rx.Observable.interval(5000)); var ones = clicksInFiveSeconds.mapTo(1); var seed = 0; var count = ones.reduce((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/refCount.ts

refCount
refCount()

node_modules__/rxjs/src/operators/refCount.ts

refCount
refCount()

node_modules_/zone.js/lib/browser/register-element.ts

registerElementPatch
registerElementPatch(_global: any)
Parameters :
Name Type Optional Description
_global any

node_modules__/zone.js/lib/browser/register-element.ts

registerElementPatch
registerElementPatch(_global: any)
Parameters :
Name Type Optional Description
_global any

node_modules__/rxjs/src/operators/repeat.ts

repeat
repeat(count: number)

Returns an Observable that repeats the stream of items emitted by the source Observable at most count times.

Parameters :
Name Type Optional Description
count number

The number of times the source Observable items are repeated, a count of 0 will yield an empty Observable.

node_modules_/rxjs/src/operator/repeat.ts

repeat
repeat(this: typeReference, count: number)

Returns an Observable that repeats the stream of items emitted by the source Observable at most count times.

Parameters :
Name Type Optional Description
this typeReference
count number

The number of times the source Observable items are repeated, a count of 0 will yield an empty Observable.

node_modules_/rxjs/src/operators/repeat.ts

repeat
repeat(count: number)

Returns an Observable that repeats the stream of items emitted by the source Observable at most count times.

Parameters :
Name Type Optional Description
count number

The number of times the source Observable items are repeated, a count of 0 will yield an empty Observable.

node_modules__/rxjs/src/operator/repeat.ts

repeat
repeat(this: typeReference, count: number)

Returns an Observable that repeats the stream of items emitted by the source Observable at most count times.

Parameters :
Name Type Optional Description
this typeReference
count number

The number of times the source Observable items are repeated, a count of 0 will yield an empty Observable.

node_modules__/rxjs/src/operators/repeatWhen.ts

repeatWhen
repeatWhen(notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of a complete. If the source Observable calls complete, this method will emit to the Observable returned from notifier. If that Observable calls complete or error, then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the repetition.

node_modules_/rxjs/src/operator/repeatWhen.ts

repeatWhen
repeatWhen(this: typeReference, notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of a complete. If the source Observable calls complete, this method will emit to the Observable returned from notifier. If that Observable calls complete or error, then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
this typeReference
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the repetition.

node_modules_/rxjs/src/operators/repeatWhen.ts

repeatWhen
repeatWhen(notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of a complete. If the source Observable calls complete, this method will emit to the Observable returned from notifier. If that Observable calls complete or error, then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the repetition.

node_modules__/rxjs/src/operator/repeatWhen.ts

repeatWhen
repeatWhen(this: typeReference, notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of a complete. If the source Observable calls complete, this method will emit to the Observable returned from notifier. If that Observable calls complete or error, then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
this typeReference
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the repetition.

node_modules_/rxjs/src/operator/retry.ts

retry
retry(this: typeReference, count: number)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will resubscribe to the source Observable for a maximum of count resubscriptions (given as a number parameter) rather than propagating the error call.

Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

Parameters :
Name Type Optional Description
this typeReference
count number
  • Number of retry attempts before failing.

node_modules__/rxjs/src/operator/retry.ts

retry
retry(this: typeReference, count: number)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will resubscribe to the source Observable for a maximum of count resubscriptions (given as a number parameter) rather than propagating the error call.

Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

Parameters :
Name Type Optional Description
this typeReference
count number
  • Number of retry attempts before failing.

node_modules__/rxjs/src/operators/retry.ts

retry
retry(count: number)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will resubscribe to the source Observable for a maximum of count resubscriptions (given as a number parameter) rather than propagating the error call.

Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

Parameters :
Name Type Optional Description
count number
  • Number of retry attempts before failing.

node_modules_/rxjs/src/operators/retry.ts

retry
retry(count: number)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will resubscribe to the source Observable for a maximum of count resubscriptions (given as a number parameter) rather than propagating the error call.

Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

Parameters :
Name Type Optional Description
count number
  • Number of retry attempts before failing.

node_modules_/rxjs/src/operators/retryWhen.ts

retryWhen
retryWhen(notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will emit the Throwable that caused the error to the Observable returned from notifier. If that Observable calls complete or error then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the retry.

node_modules__/rxjs/src/operator/retryWhen.ts

retryWhen
retryWhen(this: typeReference, notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will emit the Throwable that caused the error to the Observable returned from notifier. If that Observable calls complete or error then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
this typeReference
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the retry.

node_modules_/rxjs/src/operator/retryWhen.ts

retryWhen
retryWhen(this: typeReference, notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will emit the Throwable that caused the error to the Observable returned from notifier. If that Observable calls complete or error then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
this typeReference
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the retry.

node_modules__/rxjs/src/operators/retryWhen.ts

retryWhen
retryWhen(notifier: undefined)

Returns an Observable that mirrors the source Observable with the exception of an error. If the source Observable calls error, this method will emit the Throwable that caused the error to the Observable returned from notifier. If that Observable calls complete or error then this method will call complete or error on the child subscription. Otherwise this method will resubscribe to the source Observable.

Parameters :
Name Type Optional Description
notifier
  • Receives an Observable of notifications with which a user can complete or error, aborting the retry.

node_modules_/code-block-writer/src/tests/code-block-writer-tests.ts

runTestsForNewLineChar
runTestsForNewLineChar(opts: undefined)
Parameters :
Name Type Optional Description
opts

node_modules__/code-block-writer/src/tests/code-block-writer-tests.ts

runTestsForNewLineChar
runTestsForNewLineChar(opts: undefined)
Parameters :
Name Type Optional Description
opts

node_modules__/rxjs/src/operator/sample.ts

sample
sample(this: typeReference, notifier: typeReference)

Emits the most recently emitted value from the source Observable whenever another Observable, the notifier, emits.

It's like {@link sampleTime}, but samples whenever the notifier Observable emits something.

Whenever the notifier Observable emits a value or completes, sample looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The notifier is subscribed to as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
this typeReference
notifier typeReference

The Observable to use for sampling the source Observable.

Example :

On every click, sample the most recent "seconds" timer var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = seconds.sample(clicks); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/sample.ts

sample
sample(notifier: typeReference)

Emits the most recently emitted value from the source Observable whenever another Observable, the notifier, emits.

It's like {@link sampleTime}, but samples whenever the notifier Observable emits something.

Whenever the notifier Observable emits a value or completes, sample looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The notifier is subscribed to as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
notifier typeReference

The Observable to use for sampling the source Observable.

Example :

On every click, sample the most recent "seconds" timer var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = seconds.sample(clicks); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/sample.ts

sample
sample(this: typeReference, notifier: typeReference)

Emits the most recently emitted value from the source Observable whenever another Observable, the notifier, emits.

It's like {@link sampleTime}, but samples whenever the notifier Observable emits something.

Whenever the notifier Observable emits a value or completes, sample looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The notifier is subscribed to as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
this typeReference
notifier typeReference

The Observable to use for sampling the source Observable.

Example :

On every click, sample the most recent "seconds" timer var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = seconds.sample(clicks); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/sample.ts

sample
sample(notifier: typeReference)

Emits the most recently emitted value from the source Observable whenever another Observable, the notifier, emits.

It's like {@link sampleTime}, but samples whenever the notifier Observable emits something.

Whenever the notifier Observable emits a value or completes, sample looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The notifier is subscribed to as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
notifier typeReference

The Observable to use for sampling the source Observable.

Example :

On every click, sample the most recent "seconds" timer var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = seconds.sample(clicks); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/sampleTime.ts

sampleTime
sampleTime(this: typeReference, period: number, scheduler: typeReference)

Emits the most recently emitted value from the source Observable within periodic time intervals.

Samples the source Observable at periodic time intervals, emitting what it samples.

sampleTime periodically looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The sampling happens periodically in time every period milliseconds (or the time unit defined by the optional scheduler argument). The sampling starts as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
this typeReference
period number

The sampling period expressed in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Every second, emit the most recent click at most once var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.sampleTime(1000); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/sampleTime.ts

sampleTime
sampleTime(this: typeReference, period: number, scheduler: typeReference)

Emits the most recently emitted value from the source Observable within periodic time intervals.

Samples the source Observable at periodic time intervals, emitting what it samples.

sampleTime periodically looks at the source Observable and emits whichever value it has most recently emitted since the previous sampling, unless the source has not emitted anything since the previous sampling. The sampling happens periodically in time every period milliseconds (or the time unit defined by the optional scheduler argument). The sampling starts as soon as the output Observable is subscribed.

Parameters :
Name Type Optional Description
this typeReference
period number

The sampling period expressed in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

Example :

Every second, emit the most recent click at most once var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.sampleTime(1000); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/scan.ts

scan
scan(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true
scan
scan(accumulator: undefined, seed?: undefined)

Applies an accumulator function over the source Observable, and returns each intermediate result, with an optional seed value.

It's like {@link reduce}, but emits the current accumulation whenever the source emits a value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past. Is similar to {@link reduce}, but emits the intermediate accumulations.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
accumulator

The accumulator function called on each source value.

seed true

The initial accumulation value.

Example :

Count the number of click events var clicks = Rx.Observable.fromEvent(document, 'click'); var ones = clicks.mapTo(1); var seed = 0; var count = ones.scan((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

scan
scan(accumulator: undefined, seed?: undefined)
Parameters :
Name Type Optional Description
accumulator
seed true
scan
scan(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true

node_modules__/rxjs/src/operators/scan.ts

scan
scan(accumulator: undefined, seed?: undefined)

Applies an accumulator function over the source Observable, and returns each intermediate result, with an optional seed value.

It's like {@link reduce}, but emits the current accumulation whenever the source emits a value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past. Is similar to {@link reduce}, but emits the intermediate accumulations.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
accumulator

The accumulator function called on each source value.

seed true

The initial accumulation value.

Example :

Count the number of click events var clicks = Rx.Observable.fromEvent(document, 'click'); var ones = clicks.mapTo(1); var seed = 0; var count = ones.scan((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

scan
scan(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true
scan
scan(accumulator: undefined, seed?: undefined)
Parameters :
Name Type Optional Description
accumulator
seed true
scan
scan(accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
accumulator
seed typeReference true

node_modules_/rxjs/src/operator/scan.ts

scan
scan(this: typeReference, accumulator: undefined, seed?: undefined)

Applies an accumulator function over the source Observable, and returns each intermediate result, with an optional seed value.

It's like {@link reduce}, but emits the current accumulation whenever the source emits a value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past. Is similar to {@link reduce}, but emits the intermediate accumulations.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
this typeReference
accumulator

The accumulator function called on each source value.

seed true

The initial accumulation value.

Example :

Count the number of click events var clicks = Rx.Observable.fromEvent(document, 'click'); var ones = clicks.mapTo(1); var seed = 0; var count = ones.scan((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

scan
scan(this: typeReference, accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference true
scan
scan(this: typeReference, accumulator: undefined, seed?: undefined)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed true
scan
scan(this: typeReference, accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference true

node_modules__/rxjs/src/operator/scan.ts

scan
scan(this: typeReference, accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference true
scan
scan(this: typeReference, accumulator: undefined, seed?: undefined)

Applies an accumulator function over the source Observable, and returns each intermediate result, with an optional seed value.

It's like {@link reduce}, but emits the current accumulation whenever the source emits a value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past. Is similar to {@link reduce}, but emits the intermediate accumulations.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

Parameters :
Name Type Optional Description
this typeReference
accumulator

The accumulator function called on each source value.

seed true

The initial accumulation value.

Example :

Count the number of click events var clicks = Rx.Observable.fromEvent(document, 'click'); var ones = clicks.mapTo(1); var seed = 0; var count = ones.scan((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

scan
scan(this: typeReference, accumulator: undefined, seed?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed typeReference true
scan
scan(this: typeReference, accumulator: undefined, seed?: undefined)
Parameters :
Name Type Optional Description
this typeReference
accumulator
seed true

node_modules__/rxjs/src/operators/sequenceEqual.ts

sequenceEqual
sequenceEqual(compareTo: typeReference, comparor?: undefined)

Compares all values of two observables in sequence using an optional comparor function and returns an observable of a single boolean value representing whether or not the two sequences are equal.

Checks to see of all values emitted by both observables are equal, in order.

sequenceEqual subscribes to two observables and buffers incoming values from each observable. Whenever either observable emits a value, the value is buffered and the buffers are shifted and compared from the bottom up; If any value pair doesn't match, the returned observable will emit false and complete. If one of the observables completes, the operator will wait for the other observable to complete; If the other observable emits before completing, the returned observable will emit false and complete. If one observable never completes or emits after the other complets, the returned observable will never complete.

Parameters :
Name Type Optional Description
compareTo typeReference

The observable sequence to compare the source sequence to.

comparor true

An optional function to compare each value pair

Example :

figure out if the Konami code matches var code = Rx.Observable.from([ "ArrowUp", "ArrowUp", "ArrowDown", "ArrowDown", "ArrowLeft", "ArrowRight", "ArrowLeft", "ArrowRight", "KeyB", "KeyA", "Enter" // no start key, clearly. ]);

var keys = Rx.Observable.fromEvent(document, 'keyup') .map(e => e.code); var matches = keys.bufferCount(11, 1) .mergeMap( last11 => Rx.Observable.from(last11) .sequenceEqual(code) ); matches.subscribe(matched => console.log('Successful cheat at Contra? ', matched));

node_modules_/rxjs/src/operators/sequenceEqual.ts

sequenceEqual
sequenceEqual(compareTo: typeReference, comparor?: undefined)

Compares all values of two observables in sequence using an optional comparor function and returns an observable of a single boolean value representing whether or not the two sequences are equal.

Checks to see of all values emitted by both observables are equal, in order.

sequenceEqual subscribes to two observables and buffers incoming values from each observable. Whenever either observable emits a value, the value is buffered and the buffers are shifted and compared from the bottom up; If any value pair doesn't match, the returned observable will emit false and complete. If one of the observables completes, the operator will wait for the other observable to complete; If the other observable emits before completing, the returned observable will emit false and complete. If one observable never completes or emits after the other complets, the returned observable will never complete.

Parameters :
Name Type Optional Description
compareTo typeReference

The observable sequence to compare the source sequence to.

comparor true

An optional function to compare each value pair

Example :

figure out if the Konami code matches var code = Rx.Observable.from([ "ArrowUp", "ArrowUp", "ArrowDown", "ArrowDown", "ArrowLeft", "ArrowRight", "ArrowLeft", "ArrowRight", "KeyB", "KeyA", "Enter" // no start key, clearly. ]);

var keys = Rx.Observable.fromEvent(document, 'keyup') .map(e => e.code); var matches = keys.bufferCount(11, 1) .mergeMap( last11 => Rx.Observable.from(last11) .sequenceEqual(code) ); matches.subscribe(matched => console.log('Successful cheat at Contra? ', matched));

node_modules__/rxjs/src/operator/sequenceEqual.ts

sequenceEqual
sequenceEqual(this: typeReference, compareTo: typeReference, comparor?: undefined)

Compares all values of two observables in sequence using an optional comparor function and returns an observable of a single boolean value representing whether or not the two sequences are equal.

Checks to see of all values emitted by both observables are equal, in order.

sequenceEqual subscribes to two observables and buffers incoming values from each observable. Whenever either observable emits a value, the value is buffered and the buffers are shifted and compared from the bottom up; If any value pair doesn't match, the returned observable will emit false and complete. If one of the observables completes, the operator will wait for the other observable to complete; If the other observable emits before completing, the returned observable will emit false and complete. If one observable never completes or emits after the other complets, the returned observable will never complete.

Parameters :
Name Type Optional Description
this typeReference
compareTo typeReference

The observable sequence to compare the source sequence to.

comparor true

An optional function to compare each value pair

Example :

figure out if the Konami code matches var code = Rx.Observable.from([ "ArrowUp", "ArrowUp", "ArrowDown", "ArrowDown", "ArrowLeft", "ArrowRight", "ArrowLeft", "ArrowRight", "KeyB", "KeyA", "Enter" // no start key, clearly. ]);

var keys = Rx.Observable.fromEvent(document, 'keyup') .map(e => e.code); var matches = keys.bufferCount(11, 1) .mergeMap( last11 => Rx.Observable.from(last11) .sequenceEqual(code) ); matches.subscribe(matched => console.log('Successful cheat at Contra? ', matched));

node_modules_/rxjs/src/operator/sequenceEqual.ts

sequenceEqual
sequenceEqual(this: typeReference, compareTo: typeReference, comparor?: undefined)

Compares all values of two observables in sequence using an optional comparor function and returns an observable of a single boolean value representing whether or not the two sequences are equal.

Checks to see of all values emitted by both observables are equal, in order.

sequenceEqual subscribes to two observables and buffers incoming values from each observable. Whenever either observable emits a value, the value is buffered and the buffers are shifted and compared from the bottom up; If any value pair doesn't match, the returned observable will emit false and complete. If one of the observables completes, the operator will wait for the other observable to complete; If the other observable emits before completing, the returned observable will emit false and complete. If one observable never completes or emits after the other complets, the returned observable will never complete.

Parameters :
Name Type Optional Description
this typeReference
compareTo typeReference

The observable sequence to compare the source sequence to.

comparor true

An optional function to compare each value pair

Example :

figure out if the Konami code matches var code = Rx.Observable.from([ "ArrowUp", "ArrowUp", "ArrowDown", "ArrowDown", "ArrowLeft", "ArrowRight", "ArrowLeft", "ArrowRight", "KeyB", "KeyA", "Enter" // no start key, clearly. ]);

var keys = Rx.Observable.fromEvent(document, 'keyup') .map(e => e.code); var matches = keys.bufferCount(11, 1) .mergeMap( last11 => Rx.Observable.from(last11) .sequenceEqual(code) ); matches.subscribe(matched => console.log('Successful cheat at Contra? ', matched));

node_modules__/rxjs/src/operator/share.ts

share
share(this: typeReference)

Returns a new Observable that multicasts (shares) the original Observable. As long as there is at least one Subscriber this Observable will be subscribed and emitting data. When all subscribers have unsubscribed it will unsubscribe from the source Observable. Because the Observable is multicasting it makes the stream hot.

This behaves similarly to .publish().refCount(), with a behavior difference when the source observable emits complete. .publish().refCount() will not resubscribe to the original source, however .share() will resubscribe to the original source. Observable.of("test").publish().refCount() will not re-emit "test" on new subscriptions, Observable.of("test").share() will re-emit "test" to new subscriptions.

Parameters :
Name Type Optional Description
this typeReference

node_modules_/rxjs/src/operator/share.ts

share
share(this: typeReference)

Returns a new Observable that multicasts (shares) the original Observable. As long as there is at least one Subscriber this Observable will be subscribed and emitting data. When all subscribers have unsubscribed it will unsubscribe from the source Observable. Because the Observable is multicasting it makes the stream hot.

This behaves similarly to .publish().refCount(), with a behavior difference when the source observable emits complete. .publish().refCount() will not resubscribe to the original source, however .share() will resubscribe to the original source. Observable.of("test").publish().refCount() will not re-emit "test" on new subscriptions, Observable.of("test").share() will re-emit "test" to new subscriptions.

Parameters :
Name Type Optional Description
this typeReference

node_modules_/rxjs/src/operators/share.ts

share
share()
shareSubjectFactory
shareSubjectFactory()

node_modules__/rxjs/src/operators/share.ts

share
share()
shareSubjectFactory
shareSubjectFactory()

node_modules__/rxjs/src/operators/shareReplay.ts

shareReplay
shareReplay(bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
scheduler typeReference true
shareReplayOperator
shareReplayOperator(bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
scheduler typeReference true

node_modules_/rxjs/src/operator/shareReplay.ts

shareReplay
shareReplay(this: typeReference, bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
scheduler typeReference true

node_modules_/rxjs/src/operators/shareReplay.ts

shareReplay
shareReplay(bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
scheduler typeReference true
shareReplayOperator
shareReplayOperator(bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
bufferSize number true
windowTime number true
scheduler typeReference true

node_modules__/rxjs/src/operator/shareReplay.ts

shareReplay
shareReplay(this: typeReference, bufferSize?: number, windowTime?: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
bufferSize number true
windowTime number true
scheduler typeReference true

node_modules_/rxjs/src/operators/single.ts

single
single(predicate?: undefined)

Returns an Observable that emits the single item emitted by the source Observable that matches a specified predicate, if that Observable emits one such item. If the source Observable emits more than one such item or no such items, notify of an IllegalArgumentException or NoSuchElementException respectively.

Parameters :
Name Type Optional Description
predicate true
  • A predicate function to evaluate items emitted by the source Observable.

node_modules__/rxjs/src/operators/single.ts

single
single(predicate?: undefined)

Returns an Observable that emits the single item emitted by the source Observable that matches a specified predicate, if that Observable emits one such item. If the source Observable emits more than one such item or no such items, notify of an IllegalArgumentException or NoSuchElementException respectively.

Parameters :
Name Type Optional Description
predicate true
  • A predicate function to evaluate items emitted by the source Observable.

node_modules_/rxjs/src/operator/single.ts

single
single(this: typeReference, predicate?: undefined)

Returns an Observable that emits the single item emitted by the source Observable that matches a specified predicate, if that Observable emits one such item. If the source Observable emits more than one such item or no such items, notify of an IllegalArgumentException or NoSuchElementException respectively.

Parameters :
Name Type Optional Description
this typeReference
predicate true
  • A predicate function to evaluate items emitted by the source Observable.

node_modules__/rxjs/src/operator/single.ts

single
single(this: typeReference, predicate?: undefined)

Returns an Observable that emits the single item emitted by the source Observable that matches a specified predicate, if that Observable emits one such item. If the source Observable emits more than one such item or no such items, notify of an IllegalArgumentException or NoSuchElementException respectively.

Parameters :
Name Type Optional Description
this typeReference
predicate true
  • A predicate function to evaluate items emitted by the source Observable.

node_modules_/rxjs/src/operator/skip.ts

skip
skip(this: typeReference, count: number)

Returns an Observable that skips the first count items emitted by the source Observable.

Parameters :
Name Type Optional Description
this typeReference
count number
  • The number of times, items emitted by source Observable should be skipped.

node_modules__/rxjs/src/operators/skip.ts

skip
skip(count: number)

Returns an Observable that skips the first count items emitted by the source Observable.

Parameters :
Name Type Optional Description
count number
  • The number of times, items emitted by source Observable should be skipped.

node_modules_/rxjs/src/operators/skip.ts

skip
skip(count: number)

Returns an Observable that skips the first count items emitted by the source Observable.

Parameters :
Name Type Optional Description
count number
  • The number of times, items emitted by source Observable should be skipped.

node_modules__/rxjs/src/operator/skip.ts

skip
skip(this: typeReference, count: number)

Returns an Observable that skips the first count items emitted by the source Observable.

Parameters :
Name Type Optional Description
this typeReference
count number
  • The number of times, items emitted by source Observable should be skipped.

node_modules_/rxjs/src/operator/skipLast.ts

skipLast
skipLast(this: typeReference, count: number)

Skip the last count values emitted by the source Observable.

skipLast returns an Observable that accumulates a queue with a length enough to store the first count values. As more values are received, values are taken from the front of the queue and produced on the result sequence. This causes values to be delayed.

Parameters :
Name Type Optional Description
this typeReference
count number

Number of elements to skip from the end of the source Observable.

Example :

Skip the last 2 values of an Observable with many values var many = Rx.Observable.range(1, 5); var skipLastTwo = many.skipLast(2); skipLastTwo.subscribe(x => console.log(x));

// Results in: // 1 2 3

node_modules__/rxjs/src/operators/skipLast.ts

skipLast
skipLast(count: number)

Skip the last count values emitted by the source Observable.

skipLast returns an Observable that accumulates a queue with a length enough to store the first count values. As more values are received, values are taken from the front of the queue and produced on the result sequence. This causes values to be delayed.

Parameters :
Name Type Optional Description
count number

Number of elements to skip from the end of the source Observable.

Example :

Skip the last 2 values of an Observable with many values var many = Rx.Observable.range(1, 5); var skipLastTwo = many.skipLast(2); skipLastTwo.subscribe(x => console.log(x));

// Results in: // 1 2 3

node_modules__/rxjs/src/operator/skipLast.ts

skipLast
skipLast(this: typeReference, count: number)

Skip the last count values emitted by the source Observable.

skipLast returns an Observable that accumulates a queue with a length enough to store the first count values. As more values are received, values are taken from the front of the queue and produced on the result sequence. This causes values to be delayed.

Parameters :
Name Type Optional Description
this typeReference
count number

Number of elements to skip from the end of the source Observable.

Example :

Skip the last 2 values of an Observable with many values var many = Rx.Observable.range(1, 5); var skipLastTwo = many.skipLast(2); skipLastTwo.subscribe(x => console.log(x));

// Results in: // 1 2 3

node_modules_/rxjs/src/operators/skipLast.ts

skipLast
skipLast(count: number)

Skip the last count values emitted by the source Observable.

skipLast returns an Observable that accumulates a queue with a length enough to store the first count values. As more values are received, values are taken from the front of the queue and produced on the result sequence. This causes values to be delayed.

Parameters :
Name Type Optional Description
count number

Number of elements to skip from the end of the source Observable.

Example :

Skip the last 2 values of an Observable with many values var many = Rx.Observable.range(1, 5); var skipLastTwo = many.skipLast(2); skipLastTwo.subscribe(x => console.log(x));

// Results in: // 1 2 3

node_modules_/rxjs/src/operator/skipUntil.ts

skipUntil
skipUntil(this: typeReference, notifier: typeReference)

Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.

Parameters :
Name Type Optional Description
this typeReference
notifier typeReference
  • The second Observable that has to emit an item before the source Observable's elements begin to be mirrored by the resulting Observable.

node_modules__/rxjs/src/operator/skipUntil.ts

skipUntil
skipUntil(this: typeReference, notifier: typeReference)

Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.

Parameters :
Name Type Optional Description
this typeReference
notifier typeReference
  • The second Observable that has to emit an item before the source Observable's elements begin to be mirrored by the resulting Observable.

node_modules__/rxjs/src/operators/skipUntil.ts

skipUntil
skipUntil(notifier: typeReference)

Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.

Parameters :
Name Type Optional Description
notifier typeReference
  • The second Observable that has to emit an item before the source Observable's elements begin to be mirrored by the resulting Observable.

node_modules_/rxjs/src/operators/skipUntil.ts

skipUntil
skipUntil(notifier: typeReference)

Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.

Parameters :
Name Type Optional Description
notifier typeReference
  • The second Observable that has to emit an item before the source Observable's elements begin to be mirrored by the resulting Observable.

node_modules_/rxjs/src/operator/skipWhile.ts

skipWhile
skipWhile(this: typeReference, predicate: undefined)

Returns an Observable that skips all items emitted by the source Observable as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

Parameters :
Name Type Optional Description
this typeReference
predicate
  • A function to test each item emitted from the source Observable.

node_modules__/rxjs/src/operator/skipWhile.ts

skipWhile
skipWhile(this: typeReference, predicate: undefined)

Returns an Observable that skips all items emitted by the source Observable as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

Parameters :
Name Type Optional Description
this typeReference
predicate
  • A function to test each item emitted from the source Observable.

node_modules_/rxjs/src/operators/skipWhile.ts

skipWhile
skipWhile(predicate: undefined)

Returns an Observable that skips all items emitted by the source Observable as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

Parameters :
Name Type Optional Description
predicate
  • A function to test each item emitted from the source Observable.

node_modules__/rxjs/src/operators/skipWhile.ts

skipWhile
skipWhile(predicate: undefined)

Returns an Observable that skips all items emitted by the source Observable as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

Parameters :
Name Type Optional Description
predicate
  • A function to test each item emitted from the source Observable.

node_modules_/rxjs/src/operators/startWith.ts

startWith
startWith(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
scheduler typeReference true
startWith
startWith(array: typeReference)
Parameters :
Name Type Optional Description
array typeReference
startWith
startWith(array: typeReference)

Returns an Observable that emits the items you specify as arguments before it begins to emit items emitted by the source Observable.

Parameters :
Name Type Optional Description
array typeReference

node_modules__/rxjs/src/operator/startWith.ts

startWith
startWith(this: typeReference, v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, array: typeReference)

Returns an Observable that emits the items you specify as arguments before it begins to emit items emitted by the source Observable.

Parameters :
Name Type Optional Description
this typeReference
array typeReference
startWith
startWith(this: typeReference, array: typeReference)
Parameters :
Name Type Optional Description
this typeReference
array typeReference
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true

node_modules_/rxjs/src/operator/startWith.ts

startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
scheduler typeReference true
startWith
startWith(this: typeReference, array: typeReference)
Parameters :
Name Type Optional Description
this typeReference
array typeReference
startWith
startWith(this: typeReference, array: typeReference)

Returns an Observable that emits the items you specify as arguments before it begins to emit items emitted by the source Observable.

Parameters :
Name Type Optional Description
this typeReference
array typeReference
startWith
startWith(this: typeReference, v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true

node_modules__/rxjs/src/operators/startWith.ts

startWith
startWith(array: typeReference)

Returns an Observable that emits the items you specify as arguments before it begins to emit items emitted by the source Observable.

Parameters :
Name Type Optional Description
array typeReference
startWith
startWith(array: typeReference)
Parameters :
Name Type Optional Description
array typeReference
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, v3: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, v2: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
scheduler typeReference true
startWith
startWith(v1: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
scheduler typeReference true

node_modules_/rxjs/src/operators/subscribeOn.ts

subscribeOn
subscribeOn(scheduler: typeReference, delay: number)

Asynchronously subscribes Observers to this Observable on the specified IScheduler.

Parameters :
Name Type Optional Description
scheduler typeReference
  • The IScheduler to perform subscription actions on.
delay number

node_modules_/rxjs/src/operator/subscribeOn.ts

subscribeOn
subscribeOn(this: typeReference, scheduler: typeReference, delay: number)

Asynchronously subscribes Observers to this Observable on the specified IScheduler.

Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference
  • The IScheduler to perform subscription actions on.
delay number

node_modules__/rxjs/src/operators/subscribeOn.ts

subscribeOn
subscribeOn(scheduler: typeReference, delay: number)

Asynchronously subscribes Observers to this Observable on the specified IScheduler.

Parameters :
Name Type Optional Description
scheduler typeReference
  • The IScheduler to perform subscription actions on.
delay number

node_modules__/rxjs/src/operator/subscribeOn.ts

subscribeOn
subscribeOn(this: typeReference, scheduler: typeReference, delay: number)

Asynchronously subscribes Observers to this Observable on the specified IScheduler.

Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference
  • The IScheduler to perform subscription actions on.
delay number

node_modules__/rxjs/src/util/subscribeToResult.ts

subscribeToResult
subscribeToResult(outerSubscriber: typeReference, result: typeReference, outerValue?: typeReference, outerIndex?: number)
Parameters :
Name Type Optional Description
outerSubscriber typeReference
result typeReference
outerValue typeReference true
outerIndex number true
subscribeToResult
subscribeToResult(outerSubscriber: typeReference, result: any, outerValue?: typeReference, outerIndex?: number)
Parameters :
Name Type Optional Description
outerSubscriber typeReference
result any
outerValue typeReference true
outerIndex number true

node_modules_/rxjs/src/util/subscribeToResult.ts

subscribeToResult
subscribeToResult(outerSubscriber: typeReference, result: any, outerValue?: typeReference, outerIndex?: number)
Parameters :
Name Type Optional Description
outerSubscriber typeReference
result any
outerValue typeReference true
outerIndex number true
subscribeToResult
subscribeToResult(outerSubscriber: typeReference, result: typeReference, outerValue?: typeReference, outerIndex?: number)
Parameters :
Name Type Optional Description
outerSubscriber typeReference
result typeReference
outerValue typeReference true
outerIndex number true

node_modules_/rxjs/src/operators/switchAll.ts

switchAll
switchAll()

node_modules__/rxjs/src/operators/switchAll.ts

switchAll
switchAll()

node_modules__/rxjs/src/operators/switchMap.ts

switchMap
switchMap(project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
project
resultSelector
switchMap
switchMap(project: undefined)
Parameters :
Name Type Optional Description
project
switchMap
switchMap(project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, emitting values only from the most recently projected Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link switch}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each time it observes one of these inner Observables, the output Observable begins emitting the items emitted by that inner Observable. When a new inner Observable is emitted, switchMap stops emitting items from the earlier-emitted inner Observable and begins emitting items from the new one. It continues to behave like this for subsequent inner Observables.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/switchMap.ts

switchMap
switchMap(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
switchMap
switchMap(this: typeReference, project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector
switchMap
switchMap(this: typeReference, project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, emitting values only from the most recently projected Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link switch}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each time it observes one of these inner Observables, the output Observable begins emitting the items emitted by that inner Observable. When a new inner Observable is emitted, switchMap stops emitting items from the earlier-emitted inner Observable and begins emitting items from the new one. It continues to behave like this for subsequent inner Observables.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/switchMap.ts

switchMap
switchMap(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
switchMap
switchMap(this: typeReference, project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
resultSelector
switchMap
switchMap(this: typeReference, project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, emitting values only from the most recently projected Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link switch}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each time it observes one of these inner Observables, the output Observable begins emitting the items emitted by that inner Observable. When a new inner Observable is emitted, switchMap stops emitting items from the earlier-emitted inner Observable and begins emitting items from the new one. It continues to behave like this for subsequent inner Observables.

Parameters :
Name Type Optional Description
this typeReference
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/switchMap.ts

switchMap
switchMap(project: undefined, resultSelector?: undefined)

Projects each source value to an Observable which is merged in the output Observable, emitting values only from the most recently projected Observable.

Maps each value to an Observable, then flattens all of these inner Observables using {@link switch}.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each time it observes one of these inner Observables, the output Observable begins emitting the items emitted by that inner Observable. When a new inner Observable is emitted, switchMap stops emitting items from the earlier-emitted inner Observable and begins emitting items from the new one. It continues to behave like this for subsequent inner Observables.

Parameters :
Name Type Optional Description
project

A function that, when applied to an item emitted by the source Observable, returns an Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

switchMap
switchMap(project: undefined, resultSelector: undefined)
Parameters :
Name Type Optional Description
project
resultSelector
switchMap
switchMap(project: undefined)
Parameters :
Name Type Optional Description
project

node_modules__/rxjs/src/operators/switchMapTo.ts

switchMapTo
switchMapTo(innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is flattened multiple times with {@link switch} in the output Observable.

It's like {@link switchMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. The output Observables emits values only from the most recently emitted instance of innerObservable.

Parameters :
Name Type Optional Description
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

switchMapTo
switchMapTo(observable: typeReference)
Parameters :
Name Type Optional Description
observable typeReference
switchMapTo
switchMapTo(observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
observable typeReference
resultSelector

node_modules_/rxjs/src/operators/switchMapTo.ts

switchMapTo
switchMapTo(innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is flattened multiple times with {@link switch} in the output Observable.

It's like {@link switchMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. The output Observables emits values only from the most recently emitted instance of innerObservable.

Parameters :
Name Type Optional Description
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

switchMapTo
switchMapTo(observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
observable typeReference
resultSelector
switchMapTo
switchMapTo(observable: typeReference)
Parameters :
Name Type Optional Description
observable typeReference

node_modules__/rxjs/src/operator/switchMapTo.ts

switchMapTo
switchMapTo(this: typeReference, observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
resultSelector
switchMapTo
switchMapTo(this: typeReference, innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is flattened multiple times with {@link switch} in the output Observable.

It's like {@link switchMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. The output Observables emits values only from the most recently emitted instance of innerObservable.

Parameters :
Name Type Optional Description
this typeReference
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

switchMapTo
switchMapTo(this: typeReference, observable: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference

node_modules_/rxjs/src/operator/switchMapTo.ts

switchMapTo
switchMapTo(this: typeReference, observable: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
switchMapTo
switchMapTo(this: typeReference, observable: typeReference, resultSelector: undefined)
Parameters :
Name Type Optional Description
this typeReference
observable typeReference
resultSelector
switchMapTo
switchMapTo(this: typeReference, innerObservable: typeReference, resultSelector?: undefined)

Projects each source value to the same Observable which is flattened multiple times with {@link switch} in the output Observable.

It's like {@link switchMap}, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. The output Observables emits values only from the most recently emitted instance of innerObservable.

Parameters :
Name Type Optional Description
this typeReference
innerObservable typeReference

An Observable to replace each value from the source Observable.

resultSelector true

A function to produce the value on the output Observable based on the values and the indices of the source (outer) emission and the inner Observable emission. The arguments passed to this function are:

  • outerValue: the value that came from the source
  • innerValue: the value that came from the projected Observable
  • outerIndex: the "index" of the value that came from the source
  • innerIndex: the "index" of the value from the projected Observable
Example :

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/symbol/iterator.ts

symbolIteratorPonyfill
symbolIteratorPonyfill(root: any)
Parameters :
Name Type Optional Description
root any

node_modules_/rxjs/src/symbol/iterator.ts

symbolIteratorPonyfill
symbolIteratorPonyfill(root: any)
Parameters :
Name Type Optional Description
root any

node_modules_/rxjs/src/operators/take.ts

take
take(count: number)

Emits only the first count values emitted by the source Observable.

Takes the first count values from the source, then completes.

take returns an Observable that emits only the first count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. After that, it completes, regardless if the source completes.

Parameters :
Name Type Optional Description
count number

The maximum number of next values to emit.

Example :

Take the first 5 seconds of an infinite 1-second interval Observable var interval = Rx.Observable.interval(1000); var five = interval.take(5); five.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/take.ts

take
take(this: typeReference, count: number)

Emits only the first count values emitted by the source Observable.

Takes the first count values from the source, then completes.

take returns an Observable that emits only the first count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. After that, it completes, regardless if the source completes.

Parameters :
Name Type Optional Description
this typeReference
count number

The maximum number of next values to emit.

Example :

Take the first 5 seconds of an infinite 1-second interval Observable var interval = Rx.Observable.interval(1000); var five = interval.take(5); five.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/take.ts

take
take(this: typeReference, count: number)

Emits only the first count values emitted by the source Observable.

Takes the first count values from the source, then completes.

take returns an Observable that emits only the first count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. After that, it completes, regardless if the source completes.

Parameters :
Name Type Optional Description
this typeReference
count number

The maximum number of next values to emit.

Example :

Take the first 5 seconds of an infinite 1-second interval Observable var interval = Rx.Observable.interval(1000); var five = interval.take(5); five.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/take.ts

take
take(count: number)

Emits only the first count values emitted by the source Observable.

Takes the first count values from the source, then completes.

take returns an Observable that emits only the first count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. After that, it completes, regardless if the source completes.

Parameters :
Name Type Optional Description
count number

The maximum number of next values to emit.

Example :

Take the first 5 seconds of an infinite 1-second interval Observable var interval = Rx.Observable.interval(1000); var five = interval.take(5); five.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/takeLast.ts

takeLast
takeLast(count: number)

Emits only the last count values emitted by the source Observable.

Remembers the latest count values, then emits those only when the source completes.

takeLast returns an Observable that emits at most the last count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. This operator must wait until the complete notification emission from the source in order to emit the next values on the output Observable, because otherwise it is impossible to know whether or not more values will be emitted on the source. For this reason, all values are emitted synchronously, followed by the complete notification.

Parameters :
Name Type Optional Description
count number

The maximum number of values to emit from the end of the sequence of values emitted by the source Observable.

Example :

Take the last 3 values of an Observable with many values var many = Rx.Observable.range(1, 100); var lastThree = many.takeLast(3); lastThree.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/takeLast.ts

takeLast
takeLast(this: typeReference, count: number)

Emits only the last count values emitted by the source Observable.

Remembers the latest count values, then emits those only when the source completes.

takeLast returns an Observable that emits at most the last count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. This operator must wait until the complete notification emission from the source in order to emit the next values on the output Observable, because otherwise it is impossible to know whether or not more values will be emitted on the source. For this reason, all values are emitted synchronously, followed by the complete notification.

Parameters :
Name Type Optional Description
this typeReference
count number

The maximum number of values to emit from the end of the sequence of values emitted by the source Observable.

Example :

Take the last 3 values of an Observable with many values var many = Rx.Observable.range(1, 100); var lastThree = many.takeLast(3); lastThree.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/takeLast.ts

takeLast
takeLast(count: number)

Emits only the last count values emitted by the source Observable.

Remembers the latest count values, then emits those only when the source completes.

takeLast returns an Observable that emits at most the last count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. This operator must wait until the complete notification emission from the source in order to emit the next values on the output Observable, because otherwise it is impossible to know whether or not more values will be emitted on the source. For this reason, all values are emitted synchronously, followed by the complete notification.

Parameters :
Name Type Optional Description
count number

The maximum number of values to emit from the end of the sequence of values emitted by the source Observable.

Example :

Take the last 3 values of an Observable with many values var many = Rx.Observable.range(1, 100); var lastThree = many.takeLast(3); lastThree.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/takeLast.ts

takeLast
takeLast(this: typeReference, count: number)

Emits only the last count values emitted by the source Observable.

Remembers the latest count values, then emits those only when the source completes.

takeLast returns an Observable that emits at most the last count values emitted by the source Observable. If the source emits fewer than count values then all of its values are emitted. This operator must wait until the complete notification emission from the source in order to emit the next values on the output Observable, because otherwise it is impossible to know whether or not more values will be emitted on the source. For this reason, all values are emitted synchronously, followed by the complete notification.

Parameters :
Name Type Optional Description
this typeReference
count number

The maximum number of values to emit from the end of the sequence of values emitted by the source Observable.

Example :

Take the last 3 values of an Observable with many values var many = Rx.Observable.range(1, 100); var lastThree = many.takeLast(3); lastThree.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/takeUntil.ts

takeUntil
takeUntil(notifier: typeReference)

Emits the values emitted by the source Observable until a notifier Observable emits a value.

Lets values pass until a second Observable, notifier, emits something. Then, it completes.

takeUntil subscribes and begins mirroring the source Observable. It also monitors a second Observable, notifier that you provide. If the notifier emits a value or a complete notification, the output Observable stops mirroring the source Observable and completes.

Parameters :
Name Type Optional Description
notifier typeReference

The Observable whose first emitted value will cause the output Observable of takeUntil to stop emitting values from the source Observable.

Example :

Tick every second until the first click happens var interval = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = interval.takeUntil(clicks); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/takeUntil.ts

takeUntil
takeUntil(this: typeReference, notifier: typeReference)

Emits the values emitted by the source Observable until a notifier Observable emits a value.

Lets values pass until a second Observable, notifier, emits something. Then, it completes.

takeUntil subscribes and begins mirroring the source Observable. It also monitors a second Observable, notifier that you provide. If the notifier emits a value, the output Observable stops mirroring the source Observable and completes.

Parameters :
Name Type Optional Description
this typeReference
notifier typeReference

The Observable whose first emitted value will cause the output Observable of takeUntil to stop emitting values from the source Observable.

Example :

Tick every second until the first click happens var interval = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = interval.takeUntil(clicks); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/takeUntil.ts

takeUntil
takeUntil(notifier: typeReference)

Emits the values emitted by the source Observable until a notifier Observable emits a value.

Lets values pass until a second Observable, notifier, emits something. Then, it completes.

takeUntil subscribes and begins mirroring the source Observable. It also monitors a second Observable, notifier that you provide. If the notifier emits a value or a complete notification, the output Observable stops mirroring the source Observable and completes.

Parameters :
Name Type Optional Description
notifier typeReference

The Observable whose first emitted value will cause the output Observable of takeUntil to stop emitting values from the source Observable.

Example :

Tick every second until the first click happens var interval = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = interval.takeUntil(clicks); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/takeUntil.ts

takeUntil
takeUntil(this: typeReference, notifier: typeReference)

Emits the values emitted by the source Observable until a notifier Observable emits a value.

Lets values pass until a second Observable, notifier, emits something. Then, it completes.

takeUntil subscribes and begins mirroring the source Observable. It also monitors a second Observable, notifier that you provide. If the notifier emits a value, the output Observable stops mirroring the source Observable and completes.

Parameters :
Name Type Optional Description
this typeReference
notifier typeReference

The Observable whose first emitted value will cause the output Observable of takeUntil to stop emitting values from the source Observable.

Example :

Tick every second until the first click happens var interval = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var result = interval.takeUntil(clicks); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/takeWhile.ts

takeWhile
takeWhile(predicate: undefined)

Emits values emitted by the source Observable so long as each value satisfies the given predicate, and then completes as soon as this predicate is not satisfied.

Takes values from the source only while they pass the condition given. When the first value does not satisfy, it completes.

takeWhile subscribes and begins mirroring the source Observable. Each value emitted on the source is given to the predicate function which returns a boolean, representing a condition to be satisfied by the source values. The output Observable emits the source values until such time as the predicate returns false, at which point takeWhile stops mirroring the source Observable and completes the output Observable.

Parameters :
Name Type Optional Description
predicate

A function that evaluates a value emitted by the source Observable and returns a boolean. Also takes the (zero-based) index as the second argument.

Example :

Emit click events only while the clientX property is greater than 200 var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.takeWhile(ev => ev.clientX > 200); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/takeWhile.ts

takeWhile
takeWhile(predicate: undefined)

Emits values emitted by the source Observable so long as each value satisfies the given predicate, and then completes as soon as this predicate is not satisfied.

Takes values from the source only while they pass the condition given. When the first value does not satisfy, it completes.

takeWhile subscribes and begins mirroring the source Observable. Each value emitted on the source is given to the predicate function which returns a boolean, representing a condition to be satisfied by the source values. The output Observable emits the source values until such time as the predicate returns false, at which point takeWhile stops mirroring the source Observable and completes the output Observable.

Parameters :
Name Type Optional Description
predicate

A function that evaluates a value emitted by the source Observable and returns a boolean. Also takes the (zero-based) index as the second argument.

Example :

Emit click events only while the clientX property is greater than 200 var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.takeWhile(ev => ev.clientX > 200); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/takeWhile.ts

takeWhile
takeWhile(this: typeReference, predicate: undefined)

Emits values emitted by the source Observable so long as each value satisfies the given predicate, and then completes as soon as this predicate is not satisfied.

Takes values from the source only while they pass the condition given. When the first value does not satisfy, it completes.

takeWhile subscribes and begins mirroring the source Observable. Each value emitted on the source is given to the predicate function which returns a boolean, representing a condition to be satisfied by the source values. The output Observable emits the source values until such time as the predicate returns false, at which point takeWhile stops mirroring the source Observable and completes the output Observable.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function that evaluates a value emitted by the source Observable and returns a boolean. Also takes the (zero-based) index as the second argument.

Example :

Emit click events only while the clientX property is greater than 200 var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.takeWhile(ev => ev.clientX > 200); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/takeWhile.ts

takeWhile
takeWhile(this: typeReference, predicate: undefined)

Emits values emitted by the source Observable so long as each value satisfies the given predicate, and then completes as soon as this predicate is not satisfied.

Takes values from the source only while they pass the condition given. When the first value does not satisfy, it completes.

takeWhile subscribes and begins mirroring the source Observable. Each value emitted on the source is given to the predicate function which returns a boolean, representing a condition to be satisfied by the source values. The output Observable emits the source values until such time as the predicate returns false, at which point takeWhile stops mirroring the source Observable and completes the output Observable.

Parameters :
Name Type Optional Description
this typeReference
predicate

A function that evaluates a value emitted by the source Observable and returns a boolean. Also takes the (zero-based) index as the second argument.

Example :

Emit click events only while the clientX property is greater than 200 var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.takeWhile(ev => ev.clientX > 200); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/tap.ts

tap
tap(next: undefined, error?: undefined, complete?: undefined)
Parameters :
Name Type Optional Description
next
error true
complete true
tap
tap(nextOrObserver?: undefined, error?: undefined, complete?: undefined)

Perform a side effect for every emission on the source Observable, but return an Observable that is identical to the source.

Intercepts each emission on the source and runs a function, but returns an output which is identical to the source as long as errors don't occur.

Returns a mirrored Observable of the source Observable, but modified so that the provided Observer is called to perform a side effect for every value, error, and completion emitted by the source. Any errors that are thrown in the aforementioned Observer or handlers are safely sent down the error path of the output Observable.

This operator is useful for debugging your Observables for the correct values or performing other side effects.

Note: this is different to a subscribe on the Observable. If the Observable returned by do is not subscribed, the side effects specified by the Observer will never happen. do therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

Parameters :
Name Type Optional Description
nextOrObserver true

A normal Observer object or a callback for next.

error true

Callback for errors in the source.

complete true

Callback for the completion of the source.

Example :

Map every click to the clientX position of that click, while also logging the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks .do(ev => console.log(ev)) .map(ev => ev.clientX); positions.subscribe(x => console.log(x));

tap
tap(observer: typeReference)
Parameters :
Name Type Optional Description
observer typeReference

node_modules_/rxjs/src/operators/tap.ts

tap
tap(nextOrObserver?: undefined, error?: undefined, complete?: undefined)

Perform a side effect for every emission on the source Observable, but return an Observable that is identical to the source.

Intercepts each emission on the source and runs a function, but returns an output which is identical to the source as long as errors don't occur.

Returns a mirrored Observable of the source Observable, but modified so that the provided Observer is called to perform a side effect for every value, error, and completion emitted by the source. Any errors that are thrown in the aforementioned Observer or handlers are safely sent down the error path of the output Observable.

This operator is useful for debugging your Observables for the correct values or performing other side effects.

Note: this is different to a subscribe on the Observable. If the Observable returned by do is not subscribed, the side effects specified by the Observer will never happen. do therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

Parameters :
Name Type Optional Description
nextOrObserver true

A normal Observer object or a callback for next.

error true

Callback for errors in the source.

complete true

Callback for the completion of the source.

Example :

Map every click to the clientX position of that click, while also logging the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks .do(ev => console.log(ev)) .map(ev => ev.clientX); positions.subscribe(x => console.log(x));

tap
tap(observer: typeReference)
Parameters :
Name Type Optional Description
observer typeReference
tap
tap(next: undefined, error?: undefined, complete?: undefined)
Parameters :
Name Type Optional Description
next
error true
complete true

node_modules_/rx/ts/rx.backpressure-tests.ts

testControlled
testControlled()
testPausable
testPausable()

node_modules__/rx/ts/rx.backpressure-tests.ts

testControlled
testControlled()
testPausable
testPausable()

node_modules_/rxjs/src/operator/throttle.ts

throttle
throttle(this: typeReference, durationSelector: undefined, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for a duration determined by another Observable, then repeats this process.

It's like {@link throttleTime}, but the silencing duration is determined by a second Observable.

throttle emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
this typeReference
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration for each source value, returned as an Observable or a Promise.

config typeReference

a configuration object to define leading and trailing behavior. Defaults to { leading: true, trailing: false }.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttle(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/throttle.ts

throttle
throttle(durationSelector: undefined, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for a duration determined by another Observable, then repeats this process.

It's like {@link throttleTime}, but the silencing duration is determined by a second Observable.

throttle emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration for each source value, returned as an Observable or a Promise.

config typeReference

a configuration object to define leading and trailing behavior. Defaults to { leading: true, trailing: false }.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttle(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/throttle.ts

throttle
throttle(this: typeReference, durationSelector: undefined, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for a duration determined by another Observable, then repeats this process.

It's like {@link throttleTime}, but the silencing duration is determined by a second Observable.

throttle emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
this typeReference
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration for each source value, returned as an Observable or a Promise.

config typeReference

a configuration object to define leading and trailing behavior. Defaults to { leading: true, trailing: false }.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttle(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/throttle.ts

throttle
throttle(durationSelector: undefined, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for a duration determined by another Observable, then repeats this process.

It's like {@link throttleTime}, but the silencing duration is determined by a second Observable.

throttle emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled by calling the durationSelector function with the source value, which returns the "duration" Observable. When the duration Observable emits a value or completes, the timer is disabled, and this process repeats for the next source value.

Parameters :
Name Type Optional Description
durationSelector

A function that receives a value from the source Observable, for computing the silencing duration for each source value, returned as an Observable or a Promise.

config typeReference

a configuration object to define leading and trailing behavior. Defaults to { leading: true, trailing: false }.

Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttle(ev => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/throttleTime.ts

throttleTime
throttleTime(this: typeReference, duration: number, scheduler: typeReference, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for duration milliseconds, then repeats this process.

Lets a value pass, then ignores source values for the next duration milliseconds.

throttleTime emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
this typeReference
duration number

Time to wait before emitting another value after emitting the last value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

config typeReference
Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttleTime(1000); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/throttleTime.ts

throttleTime
throttleTime(this: typeReference, duration: number, scheduler: typeReference, config: typeReference)

Emits a value from the source Observable, then ignores subsequent source values for duration milliseconds, then repeats this process.

Lets a value pass, then ignores source values for the next duration milliseconds.

throttleTime emits the source Observable values on the output Observable when its internal timer is disabled, and ignores source values when the timer is enabled. Initially, the timer is disabled. As soon as the first source value arrives, it is forwarded to the output Observable, and then the timer is enabled. After duration milliseconds (or the time unit determined internally by the optional scheduler) has passed, the timer is disabled, and this process repeats for the next source value. Optionally takes a IScheduler for managing timers.

Parameters :
Name Type Optional Description
this typeReference
duration number

Time to wait before emitting another value after emitting the last value, measured in milliseconds or the time unit determined internally by the optional scheduler.

scheduler typeReference

The {

config typeReference
Example :

Emit clicks at a rate of at most one click per second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.throttleTime(1000); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/timeInterval.ts

timeInterval
timeInterval(this: typeReference, scheduler: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference

node_modules_/rxjs/src/operators/timeInterval.ts

timeInterval
timeInterval(scheduler: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference

node_modules_/rxjs/src/operator/timeInterval.ts

timeInterval
timeInterval(this: typeReference, scheduler: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference

node_modules__/rxjs/src/operators/timeInterval.ts

timeInterval
timeInterval(scheduler: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference

node_modules_/rxjs/src/operators/timeout.ts

timeout
timeout(due: undefined, scheduler: typeReference)

Errors if Observable does not emit a value in given time span.

Timeouts on Observable that doesn't emit values fast enough.

timeout operator accepts as an argument either a number or a Date.

If number was provided, it returns an Observable that behaves like a source Observable, unless there is a period of time where there is no value emitted. So if you provide 100 as argument and first value comes after 50ms from the moment of subscription, this value will be simply re-emitted by the resulting Observable. If however after that 100ms passes without a second value being emitted, stream will end with an error and source Observable will be unsubscribed. These checks are performed throughout whole lifecycle of Observable - from the moment it was subscribed to, until it completes or errors itself. Thus every value must be emitted within specified period since previous value.

If provided argument was Date, returned Observable behaves differently. It throws if Observable did not complete before provided Date. This means that periods between emission of particular values do not matter in this case. If Observable did not complete before provided Date, source Observable will be unsubscribed. Other than that, resulting stream behaves just as source Observable.

timeout accepts also a Scheduler as a second parameter. It is used to schedule moment (or moments) when returned Observable will check if source stream emitted value or completed.

Parameters :
Name Type Optional Description
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Check if ticks are emitted within certain timespan const seconds = Rx.Observable.interval(1000);

seconds.timeout(1100) // Let's use bigger timespan to be safe, // since interval might fire a bit later then scheduled. .subscribe( value => console.log(value), // Will emit numbers just as regular interval would. err => console.log(err) // Will never be called. );

seconds.timeout(900).subscribe( value => console.log(value), // Will never be called. err => console.log(err) // Will emit error before even first value is emitted, // since it did not arrive within 900ms period. );

Use Date to check if Observable completed const seconds = Rx.Observable.interval(1000);

seconds.timeout(new Date("December 17, 2020 03:24:00")) .subscribe( value => console.log(value), // Will emit values as regular interval would // until December 17, 2020 at 03:24:00. err => console.log(err) // On December 17, 2020 at 03:24:00 it will emit an error, // since Observable did not complete by then. );

node_modules_/rxjs/src/operator/timeout.ts

timeout
timeout(this: typeReference, due: undefined, scheduler: typeReference)

Errors if Observable does not emit a value in given time span.

Timeouts on Observable that doesn't emit values fast enough.

timeout operator accepts as an argument either a number or a Date.

If number was provided, it returns an Observable that behaves like a source Observable, unless there is a period of time where there is no value emitted. So if you provide 100 as argument and first value comes after 50ms from the moment of subscription, this value will be simply re-emitted by the resulting Observable. If however after that 100ms passes without a second value being emitted, stream will end with an error and source Observable will be unsubscribed. These checks are performed throughout whole lifecycle of Observable - from the moment it was subscribed to, until it completes or errors itself. Thus every value must be emitted within specified period since previous value.

If provided argument was Date, returned Observable behaves differently. It throws if Observable did not complete before provided Date. This means that periods between emission of particular values do not matter in this case. If Observable did not complete before provided Date, source Observable will be unsubscribed. Other than that, resulting stream behaves just as source Observable.

timeout accepts also a Scheduler as a second parameter. It is used to schedule moment (or moments) when returned Observable will check if source stream emitted value or completed.

Parameters :
Name Type Optional Description
this typeReference
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Check if ticks are emitted within certain timespan const seconds = Rx.Observable.interval(1000);

seconds.timeout(1100) // Let's use bigger timespan to be safe, // since interval might fire a bit later then scheduled. .subscribe( value => console.log(value), // Will emit numbers just as regular interval would. err => console.log(err) // Will never be called. );

seconds.timeout(900).subscribe( value => console.log(value), // Will never be called. err => console.log(err) // Will emit error before even first value is emitted, // since it did not arrive within 900ms period. );

Use Date to check if Observable completed const seconds = Rx.Observable.interval(1000);

seconds.timeout(new Date("December 17, 2020 03:24:00")) .subscribe( value => console.log(value), // Will emit values as regular interval would // until December 17, 2020 at 03:24:00. err => console.log(err) // On December 17, 2020 at 03:24:00 it will emit an error, // since Observable did not complete by then. );

node_modules__/rxjs/src/operators/timeout.ts

timeout
timeout(due: undefined, scheduler: typeReference)

Errors if Observable does not emit a value in given time span.

Timeouts on Observable that doesn't emit values fast enough.

timeout operator accepts as an argument either a number or a Date.

If number was provided, it returns an Observable that behaves like a source Observable, unless there is a period of time where there is no value emitted. So if you provide 100 as argument and first value comes after 50ms from the moment of subscription, this value will be simply re-emitted by the resulting Observable. If however after that 100ms passes without a second value being emitted, stream will end with an error and source Observable will be unsubscribed. These checks are performed throughout whole lifecycle of Observable - from the moment it was subscribed to, until it completes or errors itself. Thus every value must be emitted within specified period since previous value.

If provided argument was Date, returned Observable behaves differently. It throws if Observable did not complete before provided Date. This means that periods between emission of particular values do not matter in this case. If Observable did not complete before provided Date, source Observable will be unsubscribed. Other than that, resulting stream behaves just as source Observable.

timeout accepts also a Scheduler as a second parameter. It is used to schedule moment (or moments) when returned Observable will check if source stream emitted value or completed.

Parameters :
Name Type Optional Description
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Check if ticks are emitted within certain timespan const seconds = Rx.Observable.interval(1000);

seconds.timeout(1100) // Let's use bigger timespan to be safe, // since interval might fire a bit later then scheduled. .subscribe( value => console.log(value), // Will emit numbers just as regular interval would. err => console.log(err) // Will never be called. );

seconds.timeout(900).subscribe( value => console.log(value), // Will never be called. err => console.log(err) // Will emit error before even first value is emitted, // since it did not arrive within 900ms period. );

Use Date to check if Observable completed const seconds = Rx.Observable.interval(1000);

seconds.timeout(new Date("December 17, 2020 03:24:00")) .subscribe( value => console.log(value), // Will emit values as regular interval would // until December 17, 2020 at 03:24:00. err => console.log(err) // On December 17, 2020 at 03:24:00 it will emit an error, // since Observable did not complete by then. );

node_modules__/rxjs/src/operator/timeout.ts

timeout
timeout(this: typeReference, due: undefined, scheduler: typeReference)

Errors if Observable does not emit a value in given time span.

Timeouts on Observable that doesn't emit values fast enough.

timeout operator accepts as an argument either a number or a Date.

If number was provided, it returns an Observable that behaves like a source Observable, unless there is a period of time where there is no value emitted. So if you provide 100 as argument and first value comes after 50ms from the moment of subscription, this value will be simply re-emitted by the resulting Observable. If however after that 100ms passes without a second value being emitted, stream will end with an error and source Observable will be unsubscribed. These checks are performed throughout whole lifecycle of Observable - from the moment it was subscribed to, until it completes or errors itself. Thus every value must be emitted within specified period since previous value.

If provided argument was Date, returned Observable behaves differently. It throws if Observable did not complete before provided Date. This means that periods between emission of particular values do not matter in this case. If Observable did not complete before provided Date, source Observable will be unsubscribed. Other than that, resulting stream behaves just as source Observable.

timeout accepts also a Scheduler as a second parameter. It is used to schedule moment (or moments) when returned Observable will check if source stream emitted value or completed.

Parameters :
Name Type Optional Description
this typeReference
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Check if ticks are emitted within certain timespan const seconds = Rx.Observable.interval(1000);

seconds.timeout(1100) // Let's use bigger timespan to be safe, // since interval might fire a bit later then scheduled. .subscribe( value => console.log(value), // Will emit numbers just as regular interval would. err => console.log(err) // Will never be called. );

seconds.timeout(900).subscribe( value => console.log(value), // Will never be called. err => console.log(err) // Will emit error before even first value is emitted, // since it did not arrive within 900ms period. );

Use Date to check if Observable completed const seconds = Rx.Observable.interval(1000);

seconds.timeout(new Date("December 17, 2020 03:24:00")) .subscribe( value => console.log(value), // Will emit values as regular interval would // until December 17, 2020 at 03:24:00. err => console.log(err) // On December 17, 2020 at 03:24:00 it will emit an error, // since Observable did not complete by then. );

node_modules_/rxjs/src/operators/timeoutWith.ts

timeoutWith
timeoutWith(due: undefined, withObservable: typeReference, scheduler: typeReference)

Errors if Observable does not emit a value in given time span, in case of which subscribes to the second Observable.

It's a version of timeout operator that let's you specify fallback Observable.

timeoutWith is a variation of timeout operator. It behaves exactly the same, still accepting as a first argument either a number or a Date, which control - respectively - when values of source Observable should be emitted or when it should complete.

The only difference is that it accepts a second, required parameter. This parameter should be an Observable which will be subscribed when source Observable fails any timeout check. So whenever regular timeout would emit an error, timeoutWith will instead start re-emitting values from second Observable. Note that this fallback Observable is not checked for timeouts itself, so it can emit values and complete at arbitrary points in time. From the moment of a second subscription, Observable returned from timeoutWith simply mirrors fallback stream. When that stream completes, it completes as well.

Scheduler, which in case of timeout is provided as as second argument, can be still provided here - as a third, optional parameter. It still is used to schedule timeout checks and - as a consequence - when second Observable will be subscribed, since subscription happens immediately after failing check.

Parameters :
Name Type Optional Description
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

withObservable typeReference

Observable which will be subscribed if source fails timeout check.

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Add fallback observable const seconds = Rx.Observable.interval(1000); const minutes = Rx.Observable.interval(60 * 1000);

seconds.timeoutWith(900, minutes) .subscribe( value => console.log(value), // After 900ms, will start emitting minutes, // since first value of seconds will not arrive fast enough. err => console.log(err) // Would be called after 900ms in case of timeout, // but here will never be called. );

timeoutWith
timeoutWith(due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
due
withObservable typeReference
scheduler typeReference true
timeoutWith
timeoutWith(due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
due
withObservable typeReference
scheduler typeReference true

node_modules__/rxjs/src/operator/timeoutWith.ts

timeoutWith
timeoutWith(this: typeReference, due: undefined, withObservable: typeReference, scheduler: typeReference)

Errors if Observable does not emit a value in given time span, in case of which subscribes to the second Observable.

It's a version of timeout operator that let's you specify fallback Observable.

timeoutWith is a variation of timeout operator. It behaves exactly the same, still accepting as a first argument either a number or a Date, which control - respectively - when values of source Observable should be emitted or when it should complete.

The only difference is that it accepts a second, required parameter. This parameter should be an Observable which will be subscribed when source Observable fails any timeout check. So whenever regular timeout would emit an error, timeoutWith will instead start re-emitting values from second Observable. Note that this fallback Observable is not checked for timeouts itself, so it can emit values and complete at arbitrary points in time. From the moment of a second subscription, Observable returned from timeoutWith simply mirrors fallback stream. When that stream completes, it completes as well.

Scheduler, which in case of timeout is provided as as second argument, can be still provided here - as a third, optional parameter. It still is used to schedule timeout checks and - as a consequence - when second Observable will be subscribed, since subscription happens immediately after failing check.

Parameters :
Name Type Optional Description
this typeReference
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

withObservable typeReference

Observable which will be subscribed if source fails timeout check.

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Add fallback observable const seconds = Rx.Observable.interval(1000); const minutes = Rx.Observable.interval(60 * 1000);

seconds.timeoutWith(900, minutes) .subscribe( value => console.log(value), // After 900ms, will start emitting minutes, // since first value of seconds will not arrive fast enough. err => console.log(err) // Would be called after 900ms in case of timeout, // but here will never be called. );

timeoutWith
timeoutWith(this: typeReference, due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
due
withObservable typeReference
scheduler typeReference true
timeoutWith
timeoutWith(this: typeReference, due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
due
withObservable typeReference
scheduler typeReference true

node_modules_/rxjs/src/operator/timeoutWith.ts

timeoutWith
timeoutWith(this: typeReference, due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
due
withObservable typeReference
scheduler typeReference true
timeoutWith
timeoutWith(this: typeReference, due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
due
withObservable typeReference
scheduler typeReference true
timeoutWith
timeoutWith(this: typeReference, due: undefined, withObservable: typeReference, scheduler: typeReference)

Errors if Observable does not emit a value in given time span, in case of which subscribes to the second Observable.

It's a version of timeout operator that let's you specify fallback Observable.

timeoutWith is a variation of timeout operator. It behaves exactly the same, still accepting as a first argument either a number or a Date, which control - respectively - when values of source Observable should be emitted or when it should complete.

The only difference is that it accepts a second, required parameter. This parameter should be an Observable which will be subscribed when source Observable fails any timeout check. So whenever regular timeout would emit an error, timeoutWith will instead start re-emitting values from second Observable. Note that this fallback Observable is not checked for timeouts itself, so it can emit values and complete at arbitrary points in time. From the moment of a second subscription, Observable returned from timeoutWith simply mirrors fallback stream. When that stream completes, it completes as well.

Scheduler, which in case of timeout is provided as as second argument, can be still provided here - as a third, optional parameter. It still is used to schedule timeout checks and - as a consequence - when second Observable will be subscribed, since subscription happens immediately after failing check.

Parameters :
Name Type Optional Description
this typeReference
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

withObservable typeReference

Observable which will be subscribed if source fails timeout check.

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Add fallback observable const seconds = Rx.Observable.interval(1000); const minutes = Rx.Observable.interval(60 * 1000);

seconds.timeoutWith(900, minutes) .subscribe( value => console.log(value), // After 900ms, will start emitting minutes, // since first value of seconds will not arrive fast enough. err => console.log(err) // Would be called after 900ms in case of timeout, // but here will never be called. );

node_modules__/rxjs/src/operators/timeoutWith.ts

timeoutWith
timeoutWith(due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
due
withObservable typeReference
scheduler typeReference true
timeoutWith
timeoutWith(due: undefined, withObservable: typeReference, scheduler?: typeReference)
Parameters :
Name Type Optional Description
due
withObservable typeReference
scheduler typeReference true
timeoutWith
timeoutWith(due: undefined, withObservable: typeReference, scheduler: typeReference)

Errors if Observable does not emit a value in given time span, in case of which subscribes to the second Observable.

It's a version of timeout operator that let's you specify fallback Observable.

timeoutWith is a variation of timeout operator. It behaves exactly the same, still accepting as a first argument either a number or a Date, which control - respectively - when values of source Observable should be emitted or when it should complete.

The only difference is that it accepts a second, required parameter. This parameter should be an Observable which will be subscribed when source Observable fails any timeout check. So whenever regular timeout would emit an error, timeoutWith will instead start re-emitting values from second Observable. Note that this fallback Observable is not checked for timeouts itself, so it can emit values and complete at arbitrary points in time. From the moment of a second subscription, Observable returned from timeoutWith simply mirrors fallback stream. When that stream completes, it completes as well.

Scheduler, which in case of timeout is provided as as second argument, can be still provided here - as a third, optional parameter. It still is used to schedule timeout checks and - as a consequence - when second Observable will be subscribed, since subscription happens immediately after failing check.

Parameters :
Name Type Optional Description
due

Number specifying period within which Observable must emit values or Date specifying before when Observable should complete

withObservable typeReference

Observable which will be subscribed if source fails timeout check.

scheduler typeReference

Scheduler controlling when timeout checks occur.

Example :

Add fallback observable const seconds = Rx.Observable.interval(1000); const minutes = Rx.Observable.interval(60 * 1000);

seconds.timeoutWith(900, minutes) .subscribe( value => console.log(value), // After 900ms, will start emitting minutes, // since first value of seconds will not arrive fast enough. err => console.log(err) // Would be called after 900ms in case of timeout, // but here will never be called. );

node_modules__/rxjs/src/operator/timestamp.ts

timestamp
timestamp(this: typeReference, scheduler: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference

node_modules_/rxjs/src/operators/timestamp.ts

timestamp
timestamp(scheduler: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference

node_modules__/rxjs/src/operators/timestamp.ts

timestamp
timestamp(scheduler: typeReference)
Parameters :
Name Type Optional Description
scheduler typeReference

node_modules_/rxjs/src/operator/timestamp.ts

timestamp
timestamp(this: typeReference, scheduler: typeReference)
Parameters :
Name Type Optional Description
this typeReference
scheduler typeReference

node_modules_/rxjs/src/operators/toArray.ts

toArray
toArray()
toArrayReducer
toArrayReducer(arr: undefined, item: typeReference, index: number)
Parameters :
Name Type Optional Description
arr
item typeReference
index number

node_modules__/rxjs/src/operators/toArray.ts

toArray
toArray()
toArrayReducer
toArrayReducer(arr: undefined, item: typeReference, index: number)
Parameters :
Name Type Optional Description
arr
item typeReference
index number

node_modules_/rxjs/src/operator/toArray.ts

toArray
toArray(this: typeReference)

Collects all source emissions and emits them as an array when the source completes.

Get all values inside an array when the source completes

toArray will wait until the source Observable completes before emitting the array containing all emissions. When the source Observable errors no array will be emitted.

Parameters :
Name Type Optional Description
this typeReference
Example :

Create array from input const input = Rx.Observable.interval(100).take(4);

input.toArray() .subscribe(arr => console.log(arr)); // [0,1,2,3]

node_modules__/rxjs/src/operator/toArray.ts

toArray
toArray(this: typeReference)

Collects all source emissions and emits them as an array when the source completes.

Get all values inside an array when the source completes

toArray will wait until the source Observable completes before emitting the array containing all emissions. When the source Observable errors no array will be emitted.

Parameters :
Name Type Optional Description
this typeReference
Example :

Create array from input const input = Rx.Observable.interval(100).take(4);

input.toArray() .subscribe(arr => console.log(arr)); // [0,1,2,3]

node_modules_/rxjs/src/util/toSubscriber.ts

toSubscriber
toSubscriber(nextOrObserver?: undefined, error?: undefined, complete?: undefined)
Parameters :
Name Type Optional Description
nextOrObserver true
error true
complete true

node_modules__/rxjs/src/util/toSubscriber.ts

toSubscriber
toSubscriber(nextOrObserver?: undefined, error?: undefined, complete?: undefined)
Parameters :
Name Type Optional Description
nextOrObserver true
error true
complete true

node_modules_/rxjs/src/util/tryCatch.ts

tryCatch
tryCatch(fn: typeReference)
Parameters :
Name Type Optional Description
fn typeReference
tryCatcher
tryCatcher(this: any)
Parameters :
Name Type Optional Description
this any

node_modules__/rxjs/src/util/tryCatch.ts

tryCatch
tryCatch(fn: typeReference)
Parameters :
Name Type Optional Description
fn typeReference
tryCatcher
tryCatcher(this: any)
Parameters :
Name Type Optional Description
this any

node_modules__/rxjs/src/operators/window.ts

window
window(windowBoundaries: typeReference)

Branch out the source Observable values as a nested Observable whenever windowBoundaries emits.

It's like {@link buffer}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable windowBoundaries emits an item. Because each window is an Observable, the output is a higher-order Observable.

Parameters :
Name Type Optional Description
windowBoundaries typeReference

An Observable that completes the previous window and starts a new window.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var result = clicks.window(interval) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/window.ts

window
window(windowBoundaries: typeReference)

Branch out the source Observable values as a nested Observable whenever windowBoundaries emits.

It's like {@link buffer}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable windowBoundaries emits an item. Because each window is an Observable, the output is a higher-order Observable.

Parameters :
Name Type Optional Description
windowBoundaries typeReference

An Observable that completes the previous window and starts a new window.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var result = clicks.window(interval) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/window.ts

window
window(this: typeReference, windowBoundaries: typeReference)

Branch out the source Observable values as a nested Observable whenever windowBoundaries emits.

It's like {@link buffer}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable windowBoundaries emits an item. Because each window is an Observable, the output is a higher-order Observable.

Parameters :
Name Type Optional Description
this typeReference
windowBoundaries typeReference

An Observable that completes the previous window and starts a new window.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var result = clicks.window(interval) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/window.ts

window
window(this: typeReference, windowBoundaries: typeReference)

Branch out the source Observable values as a nested Observable whenever windowBoundaries emits.

It's like {@link buffer}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable windowBoundaries emits an item. Because each window is an Observable, the output is a higher-order Observable.

Parameters :
Name Type Optional Description
this typeReference
windowBoundaries typeReference

An Observable that completes the previous window and starts a new window.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var result = clicks.window(interval) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/windowCount.ts

windowCount
windowCount(this: typeReference, windowSize: number, startWindowEvery: number)

Branch out the source Observable values as a nested Observable with each nested Observable emitting at most windowSize values.

It's like {@link bufferCount}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows every startWindowEvery items, each containing no more than windowSize items. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If startWindowEvery is not provided, then new windows are started immediately at the start of the source and when each window completes with size windowSize.

Parameters :
Name Type Optional Description
this typeReference
windowSize number

The maximum number of values emitted by each window.

startWindowEvery number

Interval at which to start a new window. For example if startWindowEvery is 2, then a new window will be started on every other value from the source. A new window is started at the beginning of the source by default.

Example :

Ignore every 3rd click event, starting from the first one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(3) .map(win => win.skip(1)) // skip first of every 3 clicks .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Ignore every 3rd click event, starting from the third one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(2, 3) .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/windowCount.ts

windowCount
windowCount(windowSize: number, startWindowEvery: number)

Branch out the source Observable values as a nested Observable with each nested Observable emitting at most windowSize values.

It's like {@link bufferCount}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows every startWindowEvery items, each containing no more than windowSize items. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If startWindowEvery is not provided, then new windows are started immediately at the start of the source and when each window completes with size windowSize.

Parameters :
Name Type Optional Description
windowSize number

The maximum number of values emitted by each window.

startWindowEvery number

Interval at which to start a new window. For example if startWindowEvery is 2, then a new window will be started on every other value from the source. A new window is started at the beginning of the source by default.

Example :

Ignore every 3rd click event, starting from the first one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(3) .map(win => win.skip(1)) // skip first of every 3 clicks .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Ignore every 3rd click event, starting from the third one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(2, 3) .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/windowCount.ts

windowCount
windowCount(this: typeReference, windowSize: number, startWindowEvery: number)

Branch out the source Observable values as a nested Observable with each nested Observable emitting at most windowSize values.

It's like {@link bufferCount}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows every startWindowEvery items, each containing no more than windowSize items. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If startWindowEvery is not provided, then new windows are started immediately at the start of the source and when each window completes with size windowSize.

Parameters :
Name Type Optional Description
this typeReference
windowSize number

The maximum number of values emitted by each window.

startWindowEvery number

Interval at which to start a new window. For example if startWindowEvery is 2, then a new window will be started on every other value from the source. A new window is started at the beginning of the source by default.

Example :

Ignore every 3rd click event, starting from the first one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(3) .map(win => win.skip(1)) // skip first of every 3 clicks .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Ignore every 3rd click event, starting from the third one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(2, 3) .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/windowCount.ts

windowCount
windowCount(windowSize: number, startWindowEvery: number)

Branch out the source Observable values as a nested Observable with each nested Observable emitting at most windowSize values.

It's like {@link bufferCount}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows every startWindowEvery items, each containing no more than windowSize items. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If startWindowEvery is not provided, then new windows are started immediately at the start of the source and when each window completes with size windowSize.

Parameters :
Name Type Optional Description
windowSize number

The maximum number of values emitted by each window.

startWindowEvery number

Interval at which to start a new window. For example if startWindowEvery is 2, then a new window will be started on every other value from the source. A new window is started at the beginning of the source by default.

Example :

Ignore every 3rd click event, starting from the first one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(3) .map(win => win.skip(1)) // skip first of every 3 clicks .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Ignore every 3rd click event, starting from the third one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(2, 3) .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/windowTime.ts

windowTime
windowTime(this: typeReference, windowTimeSpan: number, scheduler?: typeReference)

Branch out the source Observable values as a nested Observable periodically in time.

It's like {@link bufferTime}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable starts a new window periodically, as determined by the windowCreationInterval argument. It emits each window after a fixed timespan, specified by the windowTimeSpan argument. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If windowCreationInterval is not provided, the output Observable starts a new window when the previous window of duration windowTimeSpan completes. If maxWindowCount is provided, each window will emit at most fixed number of values. Window will complete immediately after emitting last value and next one still will open as specified by windowTimeSpan and windowCreationInterval arguments.

Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number

The amount of time to fill each window.

scheduler typeReference true

The scheduler on which to schedule the intervals that determine window boundaries.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Every 5 seconds start a window 1 second long, and emit at most 2 click events per window var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Same as example above but with maxWindowCount instead of take var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000, 2) // each window has still at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

windowTime
windowTime(this: typeReference, windowTimeSpan: number, windowCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number
windowCreationInterval number
scheduler typeReference true
windowTime
windowTime(this: typeReference, windowTimeSpan: number, windowCreationInterval: number, maxWindowSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number
windowCreationInterval number
maxWindowSize number
scheduler typeReference true
windowTime
windowTime(this: typeReference, windowTimeSpan: number)
Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number

node_modules__/rxjs/src/operator/windowTime.ts

windowTime
windowTime(this: typeReference, windowTimeSpan: number)
Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number
windowTime
windowTime(this: typeReference, windowTimeSpan: number, scheduler?: typeReference)

Branch out the source Observable values as a nested Observable periodically in time.

It's like {@link bufferTime}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable starts a new window periodically, as determined by the windowCreationInterval argument. It emits each window after a fixed timespan, specified by the windowTimeSpan argument. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If windowCreationInterval is not provided, the output Observable starts a new window when the previous window of duration windowTimeSpan completes. If maxWindowCount is provided, each window will emit at most fixed number of values. Window will complete immediately after emitting last value and next one still will open as specified by windowTimeSpan and windowCreationInterval arguments.

Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number

The amount of time to fill each window.

scheduler typeReference true

The scheduler on which to schedule the intervals that determine window boundaries.

Example :

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Every 5 seconds start a window 1 second long, and emit at most 2 click events per window var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

Same as example above but with maxWindowCount instead of take var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000, 2) // each window has still at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

windowTime
windowTime(this: typeReference, windowTimeSpan: number, windowCreationInterval: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number
windowCreationInterval number
scheduler typeReference true
windowTime
windowTime(this: typeReference, windowTimeSpan: number, windowCreationInterval: number, maxWindowSize: number, scheduler?: typeReference)
Parameters :
Name Type Optional Description
this typeReference
windowTimeSpan number
windowCreationInterval number
maxWindowSize number
scheduler typeReference true

node_modules_/rxjs/src/operators/windowToggle.ts

windowToggle
windowToggle(openings: typeReference, closingSelector: undefined)

Branch out the source Observable values as a nested Observable starting from an emission from openings and ending when the output of closingSelector emits.

It's like {@link bufferToggle}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows that contain those items emitted by the source Observable between the time when the openings Observable emits an item and when the Observable returned by closingSelector emits an item.

Parameters :
Name Type Optional Description
openings typeReference

An observable of notifications to start new windows.

closingSelector

A function that takes the value emitted by the openings observable and returns an Observable, which, when it emits (either next or complete), signals that the associated window should complete.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var result = clicks.windowToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ).mergeAll(); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/windowToggle.ts

windowToggle
windowToggle(this: typeReference, openings: typeReference, closingSelector: undefined)

Branch out the source Observable values as a nested Observable starting from an emission from openings and ending when the output of closingSelector emits.

It's like {@link bufferToggle}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows that contain those items emitted by the source Observable between the time when the openings Observable emits an item and when the Observable returned by closingSelector emits an item.

Parameters :
Name Type Optional Description
this typeReference
openings typeReference

An observable of notifications to start new windows.

closingSelector

A function that takes the value emitted by the openings observable and returns an Observable, which, when it emits (either next or complete), signals that the associated window should complete.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var result = clicks.windowToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ).mergeAll(); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/windowToggle.ts

windowToggle
windowToggle(this: typeReference, openings: typeReference, closingSelector: undefined)

Branch out the source Observable values as a nested Observable starting from an emission from openings and ending when the output of closingSelector emits.

It's like {@link bufferToggle}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows that contain those items emitted by the source Observable between the time when the openings Observable emits an item and when the Observable returned by closingSelector emits an item.

Parameters :
Name Type Optional Description
this typeReference
openings typeReference

An observable of notifications to start new windows.

closingSelector

A function that takes the value emitted by the openings observable and returns an Observable, which, when it emits (either next or complete), signals that the associated window should complete.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var result = clicks.windowToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ).mergeAll(); result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/windowToggle.ts

windowToggle
windowToggle(openings: typeReference, closingSelector: undefined)

Branch out the source Observable values as a nested Observable starting from an emission from openings and ending when the output of closingSelector emits.

It's like {@link bufferToggle}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows that contain those items emitted by the source Observable between the time when the openings Observable emits an item and when the Observable returned by closingSelector emits an item.

Parameters :
Name Type Optional Description
openings typeReference

An observable of notifications to start new windows.

closingSelector

A function that takes the value emitted by the openings observable and returns an Observable, which, when it emits (either next or complete), signals that the associated window should complete.

Example :

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var result = clicks.windowToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ).mergeAll(); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operators/windowWhen.ts

windowWhen
windowWhen(closingSelector: undefined)

Branch out the source Observable values as a nested Observable using a factory function of closing Observables to determine when to start a new window.

It's like {@link bufferWhen}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable produced by the specified closingSelector function emits an item. The first window is opened immediately when subscribing to the output Observable.

Parameters :
Name Type Optional Description
closingSelector

A function that takes no arguments and returns an Observable that signals (on either next or complete) when to close the previous window and start a new one.

Example :

Emit only the first two clicks events in every window of [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks .windowWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000)) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operator/windowWhen.ts

windowWhen
windowWhen(this: typeReference, closingSelector: undefined)

Branch out the source Observable values as a nested Observable using a factory function of closing Observables to determine when to start a new window.

It's like {@link bufferWhen}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable produced by the specified closingSelector function emits an item. The first window is opened immediately when subscribing to the output Observable.

Parameters :
Name Type Optional Description
this typeReference
closingSelector

A function that takes no arguments and returns an Observable that signals (on either next or complete) when to close the previous window and start a new one.

Example :

Emit only the first two clicks events in every window of [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks .windowWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000)) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/windowWhen.ts

windowWhen
windowWhen(this: typeReference, closingSelector: undefined)

Branch out the source Observable values as a nested Observable using a factory function of closing Observables to determine when to start a new window.

It's like {@link bufferWhen}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable produced by the specified closingSelector function emits an item. The first window is opened immediately when subscribing to the output Observable.

Parameters :
Name Type Optional Description
this typeReference
closingSelector

A function that takes no arguments and returns an Observable that signals (on either next or complete) when to close the previous window and start a new one.

Example :

Emit only the first two clicks events in every window of [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks .windowWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000)) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/windowWhen.ts

windowWhen
windowWhen(closingSelector: undefined)

Branch out the source Observable values as a nested Observable using a factory function of closing Observables to determine when to start a new window.

It's like {@link bufferWhen}, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable produced by the specified closingSelector function emits an item. The first window is opened immediately when subscribing to the output Observable.

Parameters :
Name Type Optional Description
closingSelector

A function that takes no arguments and returns an Observable that signals (on either next or complete) when to close the previous window and start a new one.

Example :

Emit only the first two clicks events in every window of [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks .windowWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000)) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

node_modules__/rxjs/src/operators/withLatestFrom.ts

withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
withLatestFrom
withLatestFrom(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
withLatestFrom
withLatestFrom(array: undefined)
Parameters :
Name Type Optional Description
array
withLatestFrom
withLatestFrom(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
withLatestFrom
withLatestFrom(args: typeReference)

Combines the source Observable with other Observables to create an Observable whose values are calculated from the latest values of each, only when the source emits.

Whenever the source Observable emits a value, it computes a formula using that value plus the latest values from other input Observables, then emits the output of that formula.

withLatestFrom combines each value from the source Observable (the instance) with the latest values from the other input Observables only when the source emits a value, optionally using a project function to determine the value to be emitted on the output Observable. All input Observables must emit at least one value before the output Observable will emit a value.

Parameters :
Name Type Optional Description
args typeReference
Example :

On every click event, emit an array with the latest timer event plus the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var result = clicks.withLatestFrom(timer); result.subscribe(x => console.log(x));

withLatestFrom
withLatestFrom(project: undefined)
Parameters :
Name Type Optional Description
project
withLatestFrom
withLatestFrom(v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference

node_modules__/rxjs/src/operator/withLatestFrom.ts

withLatestFrom
withLatestFrom(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
withLatestFrom
withLatestFrom(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
withLatestFrom
withLatestFrom(this: typeReference, array: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
withLatestFrom
withLatestFrom(this: typeReference, array: undefined, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
project
withLatestFrom
withLatestFrom(this: typeReference, args: typeReference)

Combines the source Observable with other Observables to create an Observable whose values are calculated from the latest values of each, only when the source emits.

Whenever the source Observable emits a value, it computes a formula using that value plus the latest values from other input Observables, then emits the output of that formula.

withLatestFrom combines each value from the source Observable (the instance) with the latest values from the other input Observables only when the source emits a value, optionally using a project function to determine the value to be emitted on the output Observable. All input Observables must emit at least one value before the output Observable will emit a value.

Parameters :
Name Type Optional Description
this typeReference
args typeReference
Example :

On every click event, emit an array with the latest timer event plus the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var result = clicks.withLatestFrom(timer); result.subscribe(x => console.log(x));

node_modules_/rxjs/src/operator/withLatestFrom.ts

withLatestFrom
withLatestFrom(this: typeReference, args: typeReference)

Combines the source Observable with other Observables to create an Observable whose values are calculated from the latest values of each, only when the source emits.

Whenever the source Observable emits a value, it computes a formula using that value plus the latest values from other input Observables, then emits the output of that formula.

withLatestFrom combines each value from the source Observable (the instance) with the latest values from the other input Observables only when the source emits a value, optionally using a project function to determine the value to be emitted on the output Observable. All input Observables must emit at least one value before the output Observable will emit a value.

Parameters :
Name Type Optional Description
this typeReference
args typeReference
Example :

On every click event, emit an array with the latest timer event plus the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var result = clicks.withLatestFrom(timer); result.subscribe(x => console.log(x));

withLatestFrom
withLatestFrom(this: typeReference, array: undefined, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
project
withLatestFrom
withLatestFrom(this: typeReference, array: undefined)
Parameters :
Name Type Optional Description
this typeReference
array
withLatestFrom
withLatestFrom(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
project
withLatestFrom
withLatestFrom(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project

node_modules_/rxjs/src/operators/withLatestFrom.ts

withLatestFrom
withLatestFrom(args: typeReference)

Combines the source Observable with other Observables to create an Observable whose values are calculated from the latest values of each, only when the source emits.

Whenever the source Observable emits a value, it computes a formula using that value plus the latest values from other input Observables, then emits the output of that formula.

withLatestFrom combines each value from the source Observable (the instance) with the latest values from the other input Observables only when the source emits a value, optionally using a project function to determine the value to be emitted on the output Observable. All input Observables must emit at least one value before the output Observable will emit a value.

Parameters :
Name Type Optional Description
args typeReference
Example :

On every click event, emit an array with the latest timer event plus the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var result = clicks.withLatestFrom(timer); result.subscribe(x => console.log(x));

withLatestFrom
withLatestFrom(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
withLatestFrom
withLatestFrom(array: undefined)
Parameters :
Name Type Optional Description
array
withLatestFrom
withLatestFrom(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
withLatestFrom
withLatestFrom(project: undefined)
Parameters :
Name Type Optional Description
project
withLatestFrom
withLatestFrom(v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
withLatestFrom
withLatestFrom(v2: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
withLatestFrom
withLatestFrom(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference

node_modules_/rxjs/src/operators/zip.ts

zip
zip(project: undefined)
Parameters :
Name Type Optional Description
project
zip
zip(v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
project
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
project
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
zip
zip(v2: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
zip
zip(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
zip
zip(v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
project
zip
zip(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zip
zip(array: typeReference)
Parameters :
Name Type Optional Description
array typeReference
zip
zip(array: typeReference, project: undefined)
Parameters :
Name Type Optional Description
array typeReference
project
zip
zip(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
zipStatic
zipStatic(array: undefined)
Parameters :
Name Type Optional Description
array
zipStatic
zipStatic(array: undefined)
Parameters :
Name Type Optional Description
array
zipStatic
zipStatic(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
zipStatic
zipStatic(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
zipStatic
zipStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zipStatic
zipStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zipStatic
zipStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zipStatic
zipStatic(observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the values, in order, of each of its input Observables.

If the latest parameter is a function, this function is used to compute the created value from the input values. Otherwise, an array of the input values is returned.

Parameters :
Name Type Optional Description
observables typeReference
Example :
Combine age and name from different sources

let age$ = Observable.of(27, 25, 29); let name$ = Observable.of('Foo', 'Bar', 'Beer'); let isDev$ = Observable.of(true, true, false);

Observable .zip(age$, name$, isDev$, (age: number, name: string, isDev: boolean) => ({ age, name, isDev })) .subscribe(x => console.log(x));

// outputs // { age: 27, name: 'Foo', isDev: true } // { age: 25, name: 'Bar', isDev: true } // { age: 29, name: 'Beer', isDev: false }

zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
project
zipStatic
zipStatic(v1: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference

node_modules__/rxjs/src/operators/zip.ts

zip
zip(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zip
zip(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zip
zip(array: typeReference, project: undefined)
Parameters :
Name Type Optional Description
array typeReference
project
zip
zip(array: typeReference)
Parameters :
Name Type Optional Description
array typeReference
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
zip
zip(v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
zip
zip(v2: typeReference)
Parameters :
Name Type Optional Description
v2 typeReference
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
zip
zip(v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
v4 typeReference
project
zip
zip(v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
v3 typeReference
project
zip
zip(v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v2 typeReference
project
zip
zip(project: undefined)
Parameters :
Name Type Optional Description
project
zipStatic
zipStatic(v1: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
zipStatic
zipStatic(v1: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
zipStatic
zipStatic(v1: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
v1 typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
zipStatic
zipStatic(array: undefined)
Parameters :
Name Type Optional Description
array
zipStatic
zipStatic(array: undefined)
Parameters :
Name Type Optional Description
array
zipStatic
zipStatic(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
zipStatic
zipStatic(array: undefined, project: undefined)
Parameters :
Name Type Optional Description
array
project
zipStatic
zipStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zipStatic
zipStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zipStatic
zipStatic(observables: typeReference)
Parameters :
Name Type Optional Description
observables typeReference
zipStatic
zipStatic(observables: typeReference)

Combines multiple Observables to create an Observable whose values are calculated from the values, in order, of each of its input Observables.

If the latest parameter is a function, this function is used to compute the created value from the input values. Otherwise, an array of the input values is returned.

Parameters :
Name Type Optional Description
observables typeReference
Example :
Combine age and name from different sources

let age$ = Observable.of(27, 25, 29); let name$ = Observable.of('Foo', 'Bar', 'Beer'); let isDev$ = Observable.of(true, true, false);

Observable .zip(age$, name$, isDev$, (age: number, name: string, isDev: boolean) => ({ age, name, isDev })) .subscribe(x => console.log(x));

// outputs // { age: 27, name: 'Foo', isDev: true } // { age: 25, name: 'Bar', isDev: true } // { age: 29, name: 'Beer', isDev: false }

node_modules__/rxjs/src/operator/zipAll.ts

zipAll
zipAll(this: typeReference, project?: undefined)
Parameters :
Name Type Optional Description
this typeReference
project true

node_modules_/rxjs/src/operator/zipAll.ts

zipAll
zipAll(this: typeReference, project?: undefined)
Parameters :
Name Type Optional Description
this typeReference
project true

node_modules__/rxjs/src/operators/zipAll.ts

zipAll
zipAll(project?: undefined)
Parameters :
Name Type Optional Description
project true

node_modules_/rxjs/src/operators/zipAll.ts

zipAll
zipAll(project?: undefined)
Parameters :
Name Type Optional Description
project true

node_modules__/rxjs/src/operator/zip.ts

zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project
zipProto
zipProto(this: typeReference, array: typeReference)
Parameters :
Name Type Optional Description
this typeReference
array typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
zipProto
zipProto(this: typeReference, array: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
array typeReference
project
zipProto
zipProto(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
zipProto
zipProto(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
zipProto
zipProto(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
project
zipProto
zipProto(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference

node_modules_/rxjs/src/operator/zip.ts

zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
zipProto
zipProto(this: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
project
zipProto
zipProto(this: typeReference, v2: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, v5: typeReference, v6: typeReference)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
v5 typeReference
v6 typeReference
zipProto
zipProto(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
zipProto
zipProto(this: typeReference, array: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
array typeReference
project
zipProto
zipProto(this: typeReference, array: typeReference)
Parameters :
Name Type Optional Description
this typeReference
array typeReference
zipProto
zipProto(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
zipProto
zipProto(this: typeReference, observables: typeReference)
Parameters :
Name Type Optional Description
this typeReference
observables typeReference
zipProto
zipProto(this: typeReference, v2: typeReference, v3: typeReference, v4: typeReference, project: undefined)
Parameters :
Name Type Optional Description
this typeReference
v2 typeReference
v3 typeReference
v4 typeReference
project

results matching ""

    No results matching ""